-
Notifications
You must be signed in to change notification settings - Fork 1.6k
345 lines (326 loc) · 10.6 KB
/
github-ci.yaml
File metadata and controls
345 lines (326 loc) · 10.6 KB
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/tutorials/build-and-test-code/python
name: CI
on:
push:
branches:
- main
paths-ignore:
- '**/*.md'
- '**/*.rst'
pull_request:
branches:
- main
paths-ignore:
- '**/*.md'
- '**/*.rst'
workflow_dispatch:
jobs:
test_windows:
name: pytest on windows
runs-on: windows-latest
steps:
- name: Checkout Code
uses: actions/checkout@v6
with:
submodules: 'recursive'
- name: Cache Downloaded Files
id: cache-downloaded-files-windows
uses: actions/cache@v5
if: github.ref == 'refs/heads/main'
with:
path: '**/tests/pdf_cache/*'
key: cache-downloaded-files-main-${{ github.run_id }}
restore-keys: |
cache-downloaded-files-main-
cache-downloaded-files
enableCrossOsArchive: true
- name: Restore Downloaded Files
uses: actions/cache/restore@v5
if: github.ref != 'refs/heads/main'
with:
path: '**/tests/pdf_cache/*'
key: cache-downloaded-files-main-
restore-keys: |
cache-downloaded-files-main-
cache-downloaded-files
enableCrossOsArchive: true
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: '3.x'
allow-prereleases: true
- name: Upgrade pip
run: |
python -m pip install --upgrade pip
- name: Install requirements (Python 3.11+)
run: |
pip install -r requirements/ci-3.11.txt
- name: Install cryptography
run: |
pip install cryptography
- name: Install pypdf
run: |
pip install .
- name: Prepare
run: |
python -c "from tests import download_test_pdfs; download_test_pdfs()"
- name: Test with pytest
run: |
python -m pytest tests --cov=pypdf --cov-append -n auto -vv -p no:benchmark
test_macos:
name: pytest on macOS
runs-on: macos-latest
steps:
- name: Checkout Code
uses: actions/checkout@v6
with:
submodules: 'recursive'
- name: Cache Downloaded Files
id: cache-downloaded-files-mac
uses: actions/cache@v5
if: github.ref == 'refs/heads/main'
with:
path: '**/tests/pdf_cache/*'
key: cache-downloaded-files-main-${{ github.run_id }}
restore-keys: |
cache-downloaded-files-main-
cache-downloaded-files
- name: Restore Downloaded Files
uses: actions/cache/restore@v5
if: github.ref != 'refs/heads/main'
with:
path: '**/tests/pdf_cache/*'
key: cache-downloaded-files-main-
restore-keys: |
cache-downloaded-files-main-
cache-downloaded-files
- name: Setup Python (3.11+)
uses: actions/setup-python@v6
with:
python-version: '3.x'
allow-prereleases: true
- name: Upgrade pip
run: |
python -m pip install --upgrade pip
- name: Install requirements (Python 3.11+)
run: |
pip install -r requirements/ci-3.11.txt
- name: Install cryptography
run: |
pip install cryptography
- name: Install OS dependencies
run:
brew install ghostscript jbig2dec poppler
- name: Install pypdf
run: |
pip install .
- name: Prepare
run: |
python -c "from tests import download_test_pdfs; download_test_pdfs()"
- name: Test with pytest
run: |
python -m pytest tests --cov=pypdf --cov-append -n auto -vv -p no:benchmark
tests:
name: "pytest on ${{ matrix.python-version }} (crypto-lib: ${{ matrix.use-crypto-lib }})"
runs-on: ubuntu-24.04
strategy:
matrix:
python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14'] # , 'pypy3.11']
use-crypto-lib: ['cryptography']
include:
- python-version: '3.9'
use-crypto-lib: 'pycryptodome'
- python-version: '3.9'
use-crypto-lib: 'none'
steps:
- name: Update APT packages
run:
sudo apt-get update
- name: Install APT dependencies
run:
sudo apt-get install ghostscript jbig2dec poppler-utils
- name: Checkout Code
uses: actions/checkout@v6
with:
submodules: 'recursive'
- name: Cache Downloaded Files
id: cache-downloaded-files
uses: actions/cache@v5
if: github.ref == 'refs/heads/main'
with:
path: '**/tests/pdf_cache/*'
key: cache-downloaded-files-main-${{ github.run_id }}
restore-keys: |
cache-downloaded-files-main-
cache-downloaded-files
- name: Restore Downloaded Files
uses: actions/cache/restore@v5
if: github.ref != 'refs/heads/main'
with:
path: '**/tests/pdf_cache/*'
key: cache-downloaded-files-main-
restore-keys: |
cache-downloaded-files-main-
cache-downloaded-files
- name: Setup Python
uses: actions/setup-python@v6
if: matrix.python-version == '3.9' || matrix.python-version == '3.10'
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
cache-dependency-path: '**/requirements/ci.txt'
- name: Setup Python (3.11+)
uses: actions/setup-python@v6
if: matrix.python-version != '3.9' && matrix.python-version != '3.10'
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
cache: 'pip'
cache-dependency-path: '**/requirements/ci-3.11.txt'
- name: Upgrade pip
run: |
python -m pip install --upgrade pip
- name: Install requirements (Python 3)
run: |
pip install -r requirements/ci.txt
if: matrix.python-version == '3.9' || matrix.python-version == '3.10'
- name: Install requirements (Python 3.11+)
run: |
pip install -r requirements/ci-3.11.txt
if: matrix.python-version != '3.9' && matrix.python-version != '3.10'
- name: Remove pycryptodome and cryptography
run: |
pip uninstall pycryptodome cryptography -y
- name: Install cryptography
run: |
pip install cryptography
if: matrix.use-crypto-lib == 'cryptography'
- name: Install pycryptodome
run: |
pip install pycryptodome
if: matrix.use-crypto-lib == 'pycryptodome'
- name: Install pypdf
run: |
pip install .
- name: Download test files
run: |
python -c "from tests import download_test_pdfs; download_test_pdfs()"
- name: Test with pytest
run: |
python -m pytest tests --cov=pypdf --cov-append -n auto -vv -p no:benchmark
if: ${{ !startsWith(matrix.python-version, 'pypy') }}
- name: Test with pytest (PyPy, no coverage)
# Coverage on PyPy is skipped because running coverage with PyPy is slow and CPython test already provides
# complete coverage data for the same code
run: |
python -m pytest tests -n auto -vv -p no:benchmark -o faulthandler_timeout=60 --dist=loadfile
if: ${{ startsWith(matrix.python-version, 'pypy') }}
- name: Rename coverage data file
run: mv .coverage ".coverage.$RANDOM"
if: ${{ !startsWith(matrix.python-version, 'pypy') }}
- name: Upload coverage data
uses: actions/upload-artifact@v7
if: ${{ !startsWith(matrix.python-version, 'pypy') }}
with:
name: coverage-data.${{ matrix.python-version }}-${{ matrix.use-crypto-lib }}
path: .coverage.*
if-no-files-found: ignore
include-hidden-files: true
codestyle:
name: Check code style issues
runs-on: ubuntu-24.04
steps:
- name: Checkout Code
uses: actions/checkout@v6
with:
submodules: 'recursive'
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: '3.x'
cache: 'pip'
cache-dependency-path: '**/requirements/ci-3.11.txt'
- name: Upgrade pip
run: |
python -m pip install --upgrade pip
- name: Install requirements
run: |
pip install -r requirements/ci-3.11.txt
- name: Install pypdf
run: |
pip install .
- name: Test with ruff
run: |
echo `ruff --version`
ruff check .
- name: Test with mypy
run : |
mypy pypdf
- name: Install docs requirements
run: |
pip install -r requirements/docs.txt
- name: Test docs build
working-directory: ./docs
run: |
sphinx-build --nitpicky --fail-on-warning --keep-going --show-traceback -d _build/doctrees --builder html . _build/html
- name: Test docs examples
working-directory: ./docs
run: |
sphinx-build -d _build/doctrees --builder doctest . _build/doctest
- name: Check with pre-commit
run: |
pip install -r requirements/dev.txt
pre-commit run --all-files --show-diff-on-failure
package:
name: Build & verify package
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: '3.x'
- run: python -m pip install flit check-wheel-contents
- run: flit build
- run: ls -l dist
- name: Test CHANGELOG.md present in sdist
run: tar -tzf dist/*.tar.gz | grep -q 'CHANGELOG.md'
- name: Test of bdist
run: check-wheel-contents dist/*.whl
- name: Test installing package
run: python -m pip install .
- name: Test running installed package
working-directory: /tmp
run: python -c "import pypdf;print(pypdf.__version__)"
coverage:
name: Combine & check coverage.
runs-on: ubuntu-latest
needs: tests
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: '3.x'
- run: python -m pip install --upgrade coverage[toml]
- uses: actions/download-artifact@v8
with:
pattern: coverage-data*
merge-multiple: true
- name: Check Number of Downloaded Files
run: |
downloaded_files_count=$(find \.coverage* -type f | wc -l)
if [ $downloaded_files_count -eq 8 ]; then
echo "The expected number of files (8) were downloaded."
else
echo "ERROR: Expected 8 files, but found $downloaded_files_count files."
exit 1
fi
- name: Combine coverage & create xml report
run: |
python -m coverage combine
python -m coverage xml
- name: Upload Coverage to Codecov
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./coverage.xml