-
-
Notifications
You must be signed in to change notification settings - Fork 10
228 lines (195 loc) · 5.58 KB
/
ci.yml
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
---
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
env:
FORCE_COLOR: "1" # Make tools pretty.
PIP_DISABLE_PIP_VERSION_CHECK: "1"
PIP_NO_PYTHON_VERSION_WARNING: "1"
permissions: {}
jobs:
build-package:
name: Build & verify package
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: hynek/build-and-inspect-python-package@v1
tests:
name: Tests on ${{ matrix.python-version }}
runs-on: ubuntu-latest
needs: build-package
strategy:
fail-fast: false
matrix:
python-version:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
steps:
- name: Download pre-built packages
uses: actions/download-artifact@v3
with:
name: Packages
path: dist
- name: Get tests & config from sdist
run: |
tar xf dist/*.tar.gz --strip-components=1
rm -rf src
- uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
cache: pip
- name: Prepare & run Nox
run: |
python -Im pip install nox "tomli; python_version<'3.11'"
python -Im nox \
--python ${{ matrix.python-version }} \
--sessions tests \
-- --installpkg dist/*.whl
- name: Upload coverage data
uses: actions/upload-artifact@v3
with:
name: coverage-data
path: .coverage.*
if-no-files-found: ignore
coverage:
name: Combine & check coverage.
runs-on: ubuntu-latest
needs: tests
if: always()
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
cache: pip
python-version-file: .python-version-default
- uses: actions/download-artifact@v3
with:
name: coverage-data
- name: Combine coverage & fail if it's <100%.
run: |
python -Im pip install --upgrade coverage[toml]
python -Im coverage combine
python -Im coverage html --skip-covered --skip-empty
# Report and write to summary.
python -Im coverage report | sed 's/^/ /' >> $GITHUB_STEP_SUMMARY
# Report again and fail if under 100%.
python -Im coverage report --fail-under=100
- name: Upload HTML report if check failed.
uses: actions/upload-artifact@v3
with:
name: html-report
path: htmlcov
if: ${{ failure() }}
mypy-api:
name: Type-check API on ${{ matrix.python-version }}
runs-on: ubuntu-latest
needs: build-package
strategy:
fail-fast: false
matrix:
python-version:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
steps:
- name: Download pre-built packages
uses: actions/download-artifact@v3
with:
name: Packages
path: dist
- run: tar xf dist/*.tar.gz --strip-components=1 # needed for config files
- uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
cache: pip
- name: Prepare & run Nox
run: |
python -Im pip install nox "tomli; python_version<'3.11'"
python -Im nox \
--python ${{ matrix.python-version }} \
--sessions mypy_api
mypy-pkg:
name: Type-check package
runs-on: ubuntu-latest
needs: build-package
steps:
- name: Download pre-built packages
uses: actions/download-artifact@v3
with:
name: Packages
path: dist
- run: tar xf dist/*.tar.gz --strip-components=1 # needed for config files
- uses: actions/setup-python@v4
with:
cache: pip
python-version-file: .python-version-default
- name: Prepare & run Nox
run: |
python -Im pip install nox "tomli; python_version<'3.11'"
python -Im nox \
--sessions mypy_pkg
docs:
name: Build docs & run doctests
runs-on: ubuntu-latest
needs: build-package
steps:
- name: Download pre-built packages
uses: actions/download-artifact@v3
with:
name: Packages
path: dist
- run: tar xf dist/*.tar.gz --strip-components=1
- uses: actions/setup-python@v4
with:
# Keep in sync with .readthedocs.yaml
python-version: "3.11"
cache: pip
- name: Prepare & run Nox
run: |
python -Im pip install nox
python -Im nox \
--session docs
install-dev:
name: Verify dev env
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
cache: pip
python-version-file: .python-version-default
- name: Install in dev mode & import
run: |
python -Im pip install -e .[dev]
python -Ic 'import stamina; print(stamina.__version__)'
required-checks-pass:
name: Ensure everything required is passing for branch protection.
if: always()
needs:
- coverage
- install-dev
- docs
- mypy-api
- mypy-pkg
runs-on: ubuntu-latest
steps:
- name: Decide whether the needed jobs succeeded or failed
uses: re-actors/alls-green@release/v1
with:
jobs: ${{ toJSON(needs) }}