Repository navigation
252 lines (217 loc) · 8.64 KB
/
Copy path_checks.yaml
File metadata and controls
252 lines (217 loc) · 8.64 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
name: Checks
on:
# Runs when invoked by another workflow. For manual runs, dispatch `CI (master)` instead — that wraps this
# workflow via `uses:`, so the resulting check-run names get the `Checks /` prefix that the manual release
# workflows look for via `wait-for-checks`.
workflow_call:
inputs:
run_tests:
description: Whether to run the unit and integration test suites.
required: false
type: boolean
default: true
permissions:
contents: read
env:
NODE_VERSION: 24
jobs:
actions_lint_check:
name: Actions lint check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Run actionlint
uses: rhysd/actionlint@914e7df21a07ef503a81201c76d2b11c789d3fca # v1.7.12
spell_check:
name: Spell check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Check spelling with typos
uses: crate-ci/typos@276087d9a4f06398b3e04825487805e2d7375888 # v1.52.2
lint_check:
name: Lint check
uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
with:
python_versions: '["3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]'
type_check:
name: Type check
uses: apify/workflows/.github/workflows/python_type_check.yaml@main
with:
python_versions: '["3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]'
markdown_lint_check:
name: Markdown lint check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Set up Node
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
node-version: ${{ env.NODE_VERSION }}
- name: Install pnpm and website dependencies
uses: apify/actions/pnpm-install@v1.6.2
with:
working-directory: website
- name: Lint Markdown
run: pnpm lint:md
working-directory: website
website_lint_check:
name: Website lint check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Set up Node
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
node-version: ${{ env.NODE_VERSION }}
- name: Install pnpm and website dependencies
uses: apify/actions/pnpm-install@v1.6.2
with:
working-directory: website
- name: Lint website code
run: pnpm lint:code
working-directory: website
- name: Check website formatting
run: pnpm format:check
working-directory: website
image_lint_check:
name: Image lint check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
# Doc images must be committed as optimized `.webp`. This fails when a PR adds raster
# images in another format so they get converted via `pnpm opt:images` first.
- name: Get changed unoptimized images
id: changed-files
uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
with:
files: |
docs/**/*.{png,jpg,jpeg,gif,bmp,tif,tiff,avif}
website/static/**/*.{png,jpg,jpeg,gif,bmp,tif,tiff,avif}
separator: "\n"
- name: Fail on unoptimized images
if: steps.changed-files.outputs.any_changed == 'true'
env:
UNOPTIMIZED_IMAGE_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
run: |
echo "Unoptimized images detected! Convert each one to WebP, e.g.:"
echo ""
while IFS= read -r file_path; do
echo " (cd website && pnpm opt:images \"../$file_path\")"
done <<< "$UNOPTIMIZED_IMAGE_FILES"
echo ""
echo "Then reference the resulting .webp files in your Markdown."
exit 1
unit_tests:
name: Unit tests
if: inputs.run_tests
uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
secrets: inherit
with:
python_versions: '["3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]'
operating_systems: '["ubuntu-latest", "windows-latest", "macos-latest"]'
python_version_for_codecov: "3.15"
operating_system_for_codecov: ubuntu-latest
tests_concurrency: "8"
integration_tests:
name: Integration tests (${{ matrix.python-version }}, ${{ matrix.os }})
if: inputs.run_tests
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
# The oldest and newest supported Python; the unit tests cover every version in between.
python-version: ["3.10", "3.15"]
runs-on: ${{ matrix.os }}
timeout-minutes: 60
env:
TESTS_CONCURRENCY: "8"
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
steps:
- name: macOS cleanup
if: runner.os == 'macOS'
# Disable Spotlight indexing and stop background processes that drain CPU during the tests.
run: |
sudo mdutil -i off /
sudo killall Finder spindump ecosystemanalyticsd SystemUIServer NotificationCenter mds mds_stores mds_worker mdworker mdworker_shared || true
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
# The default Windows temp dir is a network disk, about 5x slower at small files than RUNNER_TEMP.
- name: Use the runner's local disk for temp files
if: runner.os == 'Windows'
shell: bash
run: |
echo "TMP=$RUNNER_TEMP" >> "$GITHUB_ENV"
echo "TEMP=$RUNNER_TEMP" >> "$GITHUB_ENV"
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: ${{ matrix.python-version }}
- name: Set up uv package manager
uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
with:
python-version: ${{ matrix.python-version }}
- name: Install Python dependencies
run: uv run poe install-dev
- name: Run integration tests
run: uv run poe integration-tests-cov
# Codecov merges this upload with the unit test one, so the reported coverage covers both suites.
- name: Upload integration test coverage
if: >-
${{
matrix.os == 'ubuntu-latest' &&
matrix.python-version == '3.15' &&
env.CODECOV_TOKEN != ''
}}
uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
with:
token: ${{ env.CODECOV_TOKEN }}
files: coverage-integration.xml
flags: integration
package_check:
name: Package check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Set up uv package manager
uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
with:
python-version: "3.14"
- name: Build sdist and wheel
run: uv run poe build
- name: Verify built package
uses: apify/actions/python-package-check@v1.6.2
with:
package_name: crawlee
dist_dir: dist
python_version: "3.14"
extras: all
smoke_code: |
from crawlee.crawlers import (
HttpCrawler, BeautifulSoupCrawler, ParselCrawler,
PlaywrightCrawler, AdaptivePlaywrightCrawler,
)
from crawlee.storages import Dataset, KeyValueStore, RequestQueue
from crawlee.http_clients import HttpxHttpClient, ImpitHttpClient
from crawlee import Request
HttpCrawler()
BeautifulSoupCrawler()
ParselCrawler()
# uv and pip >= 26 fall back to pre-releases when a package publishes nothing else; older pip does not,
# so a specifier like `>=0.54` on a beta-only package breaks `pip install 'crawlee[all]'` for its users.
- name: Resolve the `all` extra with pip < 26
run: |
uv venv --seed --python 3.14 .venv-pip
.venv-pip/bin/python -m pip install 'pip<26'
.venv-pip/bin/python -m pip install --dry-run "$(ls dist/*.whl)[all]"
doc_check:
name: Doc check
uses: apify/workflows/.github/workflows/python_docs_check.yaml@main