1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
name: CI
on:
workflow_dispatch: # allow manual triggering
push:
branches:
- '**' # run on all branches
tags:
- '*' # run on tag pushes so it can trigger the publish workflow
pull_request:
branches:
- '**' # run on all branches
jobs:
pydocstyle:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python 3.x
uses: actions/setup-python@v6
with:
python-version: "3.x"
- name: Cache pip packages
uses: actions/cache@v5
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install .[dev]
- name: Pydocstyle
run: pydocstyle pyvlx test/*.py examples/*.py
flake8:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python 3.x
uses: actions/setup-python@v6
with:
python-version: "3.x"
- name: Cache pip packages
uses: actions/cache@v5
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install .[dev]
- name: Flake8
run: flake8
pylint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python 3.x
uses: actions/setup-python@v6
with:
python-version: "3.x"
- name: Cache pip packages
uses: actions/cache@v5
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install .[dev]
- name: Linter Pylint
run: pylint src/pyvlx test/*.py examples/*.py
isort:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python 3.x
uses: actions/setup-python@v6
with:
python-version: "3.x"
- name: Cache pip packages
uses: actions/cache@v5
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install -e .[dev]
- name: Isort
run: isort --check-only test examples src/pyvlx
mypy:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.11", "3.12", "3.13", "3.14"]
steps:
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Cache pip packages
uses: actions/cache@v5
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install -e .[dev]
- name: Mypy
run: mypy src/pyvlx
pytest:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.11", "3.12", "3.13", "3.14"]
steps:
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Cache pip packages
uses: actions/cache@v5
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install -e .[dev]
- name: pytest
# run the tests, produce a .coverage.$pyversion file
run: pytest --cov
env:
COVERAGE_FILE: ".coverage.${{ matrix.python-version }}"
# The file name prefix must be ".coverage." for "coverage combine"
# enabled by "MERGE_COVERAGE_FILES: true" to work. A "subprocess"
# error with the message "No data to combine" will be triggered if
# this prefix is not used.
- name: Store coverage file
uses: actions/upload-artifact@v7
with:
name: coverage-${{ matrix.python-version }}
path: .coverage.${{ matrix.python-version }}
# By default hidden files/folders (i.e. starting with .) are ignored.
# You may prefer (for security reasons) not setting this and instead
# set COVERAGE_FILE above to not start with a `.`, but you cannot
# use "MERGE_COVERAGE_FILES: true" later on and need to manually
# combine the coverage file using "pipx run coverage combine"
include-hidden-files: true
coverage:
name: Generate Coverage comment
runs-on: ubuntu-latest
needs: pytest
steps:
- uses: actions/checkout@v6
with:
# This is optional since by default it's to true. The git
# operations in python-coverage-comment-action utilize the token
# stored by actions/checkout.
persist-credentials: true
- uses: actions/download-artifact@v8
id: download
with:
pattern: coverage-*
merge-multiple: true
- name: Coverage comment
id: coverage_comment
uses: py-cov-action/python-coverage-comment-action@v3
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MERGE_COVERAGE_FILES: true
- name: Store Pull Request comment to be posted
uses: actions/upload-artifact@v7
if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
with:
name: python-coverage-comment-action
path: python-coverage-comment-action.txt
notify-build:
name: Notify build and publish workflow
runs-on: ubuntu-latest
needs: ["pydocstyle","flake8", "pylint", "mypy", "pytest", "isort"]
steps:
- name: Notify publish workflow
# dispatch publish workflow when triggered by tag
if: startsWith(github.ref, 'refs/tags/')
uses: peter-evans/repository-dispatch@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
event-type: ci-workflow-found-tag
client-payload: '{"tag":"${{ github.ref_name }}", "sha":"${{ github.sha }}"}'
|
