Repository navigation
1105 lines (983 loc) Β· 48.9 KB
/
Copy pathpython-ci.yml
File metadata and controls
1105 lines (983 loc) Β· 48.9 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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
name: 'βοΈ Continuous Integration'
on:
workflow_call:
inputs:
python-version:
description: 'Python version to use'
type: string
default: '3.11'
uv-version:
description: 'UV version to use'
type: string
default: '0.11.3'
source-paths:
description: 'Source paths for quality checks'
type: string
default: 'src/ tests/'
test-directory:
description: 'Test directory'
type: string
default: 'tests/'
coverage-threshold:
description: 'Coverage threshold percentage'
type: number
default: 80
run-security:
description: 'Run security scanning (bandit)'
type: boolean
default: true
run-secret-scan:
description: 'Run secret scanning (TruffleHog, Gitleaks)'
type: boolean
default: true
# Off by default because it preserves what this workflow has always done:
# the dependency audit was wrapped in `|| true` at every call site, so a
# finding has never stopped a build. Turning it on is a per-repo decision
# -- thirteen repositories call this workflow, and a shared default that
# reddens all of them at once is not one this workflow should make.
fail-on-vulnerability:
description: 'Fail the security job when pip-audit reports a known vulnerability'
type: boolean
default: false
ignore-vulnerabilities:
description: 'Advisory IDs the project has accepted, comma-separated'
type: string
default: ''
run-performance:
description: 'Run performance tests'
type: boolean
default: false
matrix-testing:
description: 'Enable matrix testing across Python versions (3.11, 3.12, 3.13, 3.14)'
type: boolean
default: false
platform-preset:
description: 'Platform preset: minimal (linux x64 only), standard (linux + macos + windows amd64), full (+ windows arm64)'
type: string
default: 'standard'
include-windows:
description: 'Include Windows amd64 under the minimal preset, which does not carry it. standard and full already do'
type: boolean
default: false
# Separate from include-windows because the two are not equally available.
# A project can be healthy on Windows amd64 and unable to install at all
# on Windows arm64: grpcio 1.83.0 publishes win32 and win_amd64 wheels
# only (grpc/grpc#39064 open upstream) and cryptography 50.0.0 publishes
# win_amd64 only, so anything requiring them fails during `uv sync` on
# windows-11-arm long before a test runs. Asking for Windows coverage
# should not force a caller to take a permanently red job.
include-windows-arm:
description: 'Include Windows arm64 (off by default; see the note above on wheel availability)'
type: boolean
default: false
fail-fast:
description: 'Fail fast in matrix builds'
type: boolean
default: false
upload-coverage:
description: 'Upload coverage to Codecov'
type: boolean
default: false
parallel-testing:
description: 'Enable parallel test execution with pytest-xdist (may break with some pytest plugins)'
type: boolean
default: true
use-wrknv:
description: 'Run checks via this repo''s wrknv task runner (we run <task>) instead of raw tool invocations, for local/CI command parity'
type: boolean
default: false
run-tests:
description: 'Run the pytest job(s). Disable for repos whose real verification is not pytest-based (e.g. binary conformance suites)'
type: boolean
default: true
no-sources:
description: 'Resolve dependencies from the registry, ignoring [tool.uv.sources]. Suite repos point siblings at ../<repo> for local development; CI checks out one repo, so those paths do not exist here and the published metadata is what should be verified anyway'
type: boolean
default: false
# --- branch pins -------------------------------------------------------
# Force a package to resolve from a git ref instead of the registry, so a
# PR here can build against an unreleased change in a sibling repo. See
# docs/branch-pins.md for the layers and their precedence.
dispatch-pins:
description: 'Pins from the caller''s workflow_dispatch input, as <pkg>@<ref> (highest precedence)'
type: string
default: ''
package-pins:
description: 'Pins fixed by the calling workflow, as <pkg>@<ref>'
type: string
default: ''
pins-file:
description: 'Branch-scoped pins file; the only layer that carries when-conditions'
type: string
default: '.ci/pins.toml'
auto-pin-siblings:
description: 'Pin any sibling repo that has a branch with the same name as this one. Off by default: it makes the result depend on state outside the commit'
type: boolean
default: false
sibling-repos:
description: 'Sibling repository names considered for auto-pinning. Empty derives them from this project''s dependencies, so no caller has to keep a list of its siblings in step'
type: string
default: ''
pin-allowed-orgs:
description: 'Glob patterns, as host/owner/repo, that a pin URL must match'
type: string
default: 'github.com/provide-io/*,github.com/livingstaccato/*'
pin-inputs-json:
description: 'JSON object of caller values matched by a pin''s when.input condition'
type: string
default: '{}'
block-merge-on-pins:
description: 'Fail the separate No Active Pins check while any pin is active, so branch protection can stop a pinned pull request merging. A pin is not carried by the merge, so the default branch would resolve from the registry without it. Set false to report the pins as a warning instead; the check still runs either way, because a required check that never reports blocks a repository forever'
type: boolean
default: true
secrets:
CODECOV_TOKEN:
description: 'Codecov token for coverage upload'
required: false
env:
# NOTE: Do NOT set FORCE_COLOR=1 here - it breaks pytest-xdist's execnet
# subprocess communication which expects plain output during bootstrap
UV_SYSTEM_PYTHON: "1"
# provide-foundation's tests/utils/timing.apply_timeout_factor() scales any
# timeout >= 5s by this factor when set. Real-time filesystem-watcher tests
# in that repo need the slack under -n auto's CPU contention; unused by
# every other repo on this workflow, so it's a no-op elsewhere.
PROVIDE_TEST_TIMEOUT_FACTOR: "3"
jobs:
# ==================================================================================
# π§ Code Quality & Type Checking
# ==================================================================================
quality:
name: π§ Code Quality
runs-on: ubuntu-24.04
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ inputs.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¦ Install dependencies
if: ${{ !inputs.use-wrknv }}
run: uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π¦ Install dependencies (wrknv)
if: inputs.use-wrknv
run: uv sync --all-groups ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π§ Install wrknv
if: inputs.use-wrknv
run: uv pip install --python .venv/bin/python "wrknv @ git+https://github.com/provide-io/wrknv.git@main"
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¨ Check formatting with Ruff
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/quality/run-ruff-format.sh "${{ inputs.source-paths }}" true
- name: π¨ Check formatting (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run format.check
- name: π Lint with Ruff
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/quality/run-ruff-lint.sh "${{ inputs.source-paths }}" false
- name: π Lint (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run lint
- name: π Type check with MyPy
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/quality/run-mypy.sh src/ false || true
- name: π Type check (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run typecheck
# ==================================================================================
# π§ͺ Tests - Platform Matrix
# ==================================================================================
# These names carry the platform only. GitHub appends the matrix value itself
# -- "π§ͺ Tests linux_amd64 (3.11)" -- so the Python version is still on every
# row, including the four a `matrix-testing: true` consumer spawns. A name that
# referenced matrix directly would read back raw as
# "py${{ matrix.python-version }}" on any row gated off by `if:`, because a
# skipped job has no matrix context to interpolate against. Parentheses are
# left out of the platform for the same reason: GitHub's suffix supplies them.
test:
name: π§ͺ Tests linux_amd64
needs: quality
if: inputs.run-tests
runs-on: ubuntu-24.04
strategy:
# act cannot evaluate workflow_call boolean expressions here.
fail-fast: false
matrix:
python-version: ${{ fromJson(inputs.matrix-testing && '["3.11", "3.12", "3.13", "3.14"]' || format('["{0}"]', inputs.python-version)) }}
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¦ Install dependencies
if: ${{ !inputs.use-wrknv }}
run: uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π¦ Install dependencies (wrknv)
if: inputs.use-wrknv
run: uv sync --all-groups ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π§ Install wrknv
if: inputs.use-wrknv
run: uv pip install --python .venv/bin/python "wrknv @ git+https://github.com/provide-io/wrknv.git@main"
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π§ͺ Run Tests
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/test/run-pytest.sh "${{ inputs.test-directory }}" ${{ inputs.coverage-threshold }} ${{ inputs.parallel-testing }}
- name: π§ͺ Run Tests (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run ci.test
- name: π€ Upload Coverage
if: inputs.upload-coverage && !inputs.use-wrknv && github.actor != 'nektos/act'
uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
flags: unittests
name: codecov-linux_amd64-py${{ matrix.python-version }}
# Additional platform tests (standard/full presets)
test-linux-arm:
name: π§ͺ Tests linux_arm64
needs: quality
if: inputs.run-tests && (inputs.platform-preset == 'standard' || inputs.platform-preset == 'full') && github.actor != 'nektos/act'
runs-on: ubuntu-24.04-arm
strategy:
fail-fast: false
matrix:
python-version: ${{ fromJson(inputs.matrix-testing && '["3.11", "3.12", "3.13", "3.14"]' || format('["{0}"]', inputs.python-version)) }}
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¦ Install dependencies
if: ${{ !inputs.use-wrknv }}
run: uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π¦ Install dependencies (wrknv)
if: inputs.use-wrknv
run: uv sync --all-groups ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π§ Install wrknv
if: inputs.use-wrknv
run: uv pip install --python .venv/bin/python "wrknv @ git+https://github.com/provide-io/wrknv.git@main"
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π§ͺ Run Tests
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/test/run-pytest.sh "${{ inputs.test-directory }}" ${{ inputs.coverage-threshold }} ${{ inputs.parallel-testing }}
- name: π§ͺ Run Tests (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run ci.test
test-macos-arm:
name: π§ͺ Tests darwin_arm64
needs: quality
if: inputs.run-tests && (inputs.platform-preset == 'standard' || inputs.platform-preset == 'full') && github.actor != 'nektos/act'
runs-on: macos-15
strategy:
fail-fast: false
matrix:
python-version: ${{ fromJson(inputs.matrix-testing && '["3.11", "3.12", "3.13", "3.14"]' || format('["{0}"]', inputs.python-version)) }}
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¦ Install dependencies
if: ${{ !inputs.use-wrknv }}
run: uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π¦ Install dependencies (wrknv)
if: inputs.use-wrknv
run: uv sync --all-groups ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π§ Install wrknv
if: inputs.use-wrknv
run: uv pip install --python .venv/bin/python "wrknv @ git+https://github.com/provide-io/wrknv.git@main"
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π§ͺ Run Tests
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/test/run-pytest.sh "${{ inputs.test-directory }}" ${{ inputs.coverage-threshold }} ${{ inputs.parallel-testing }}
- name: π§ͺ Run Tests (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run ci.test
test-macos-intel:
name: π§ͺ Tests darwin_amd64
needs: quality
if: inputs.run-tests && (inputs.platform-preset == 'standard' || inputs.platform-preset == 'full') && github.actor != 'nektos/act'
runs-on: macos-15-intel
strategy:
fail-fast: false
matrix:
python-version: ${{ fromJson(inputs.matrix-testing && '["3.11", "3.12", "3.13", "3.14"]' || format('["{0}"]', inputs.python-version)) }}
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¦ Install dependencies
if: ${{ !inputs.use-wrknv }}
run: uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π¦ Install dependencies (wrknv)
if: inputs.use-wrknv
run: uv sync --all-groups ${{ inputs.no-sources && '--no-sources' || '' }}
- name: π§ Install wrknv
if: inputs.use-wrknv
run: uv pip install --python .venv/bin/python "wrknv @ git+https://github.com/provide-io/wrknv.git@main"
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π§ͺ Run Tests
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/test/run-pytest.sh "${{ inputs.test-directory }}" ${{ inputs.coverage-threshold }} ${{ inputs.parallel-testing }}
- name: π§ͺ Run Tests (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run ci.test
# Windows amd64 tests. Carried by standard because Windows is where this
# org's platform bugs actually land -- a scrubbed environment that cannot
# start a process, ntpath.expanduser ignoring HOME, a TCP-only transport
# default -- and none of them are reachable from linux or macos. The runner
# holds up: 70 of 71 recent runs across pyvider, pyvider-rpcplugin and
# provide-foundation, the one failure being a sleep test that asserted a
# ceiling the platform's 15.6ms timer granularity cannot meet.
test-windows:
name: π§ͺ Tests windows_amd64
needs: quality
if: inputs.run-tests && (inputs.platform-preset == 'standard' || inputs.platform-preset == 'full' || inputs.include-windows) && github.actor != 'nektos/act'
runs-on: windows-2022
strategy:
fail-fast: false
matrix:
python-version: ${{ fromJson(inputs.matrix-testing && '["3.11", "3.12", "3.13", "3.14"]' || format('["{0}"]', inputs.python-version)) }}
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¦ Install dependencies
run: uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π§ͺ Run Tests
shell: pwsh
run: |
.venv\Scripts\Activate.ps1
pytest ${{ inputs.test-directory }} -v --tb=short
test-windows-arm:
name: π§ͺ Tests windows_arm64
needs: quality
# `full` still means every platform, so a caller asking for full is
# unaffected. What changed is that include-windows no longer drags arm64
# in with it.
if: inputs.run-tests && (inputs.platform-preset == 'full' || inputs.include-windows-arm) && github.actor != 'nektos/act'
runs-on: windows-11-arm
strategy:
fail-fast: false
matrix:
python-version: ${{ fromJson(inputs.matrix-testing && '["3.11", "3.12", "3.13", "3.14"]' || format('["{0}"]', inputs.python-version)) }}
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ matrix.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π¦ Install dependencies
run: uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π§ͺ Run Tests
shell: pwsh
run: |
.venv\Scripts\Activate.ps1
pytest ${{ inputs.test-directory }} -v --tb=short
# ==================================================================================
# π Security Scanning
# ==================================================================================
security:
name: π Security
needs: quality
if: inputs.run-security
runs-on: ubuntu-24.04
permissions:
security-events: write
contents: read
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: provide-io/ci-tooling
# The commit this reusable workflow is running from, so scripts/ come
# from the same ref the caller pinned rather than always the moving
# tag. That is what makes a SHA pin cover the whole thing. Falls back
# to v0 under act, which does not populate job_workflow_sha.
ref: ${{ github.job_workflow_sha || 'v0' }}
path: .ci-tooling
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ inputs.python-version }}
# Work out which packages this run pins. Runs before uv exists because the
# digest it emits becomes uv's cache suffix: a pinned run must not share a
# cache entry with an unpinned one.
- name: π Resolve branch pins
id: pins
uses: ./.ci-tooling/actions/resolve-pins
with:
dispatch-pins: ${{ inputs.dispatch-pins }}
variable-pins: ${{ vars.CI_PINS }}
caller-pins: ${{ inputs.package-pins }}
pins-file: ${{ inputs.pins-file }}
auto-pin-siblings: ${{ inputs.auto-pin-siblings }}
sibling-repos: ${{ inputs.sibling-repos }}
allowed-orgs: ${{ inputs.pin-allowed-orgs }}
label-pins-json: ${{ toJSON(github.event.pull_request.labels.*.name) }}
inputs-json: ${{ inputs.pin-inputs-json }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: true
cache-suffix: pins-${{ steps.pins.outputs.digest }}
# Patch the pins into [tool.uv] override-dependencies. uv honours overrides
# only from pyproject.toml, so the file has to be rewritten on disk.
- name: π Apply branch pins
uses: ./.ci-tooling/actions/apply-pins
with:
pins: ${{ steps.pins.outputs.pins }}
# Bandit reads source rather than installed packages, but it is invoked
# from this virtualenv, so it is installed here. pip-audit is not: it used
# to be, and auditing the environment a scanner was just installed into is
# what made advisories against the scanner's own dependencies show up as
# the caller's.
- name: π¦ Install dependencies
if: ${{ !inputs.use-wrknv }}
run: |
uv sync --group dev ${{ inputs.no-sources && '--no-sources' || '' }}
source .venv/bin/activate
uv pip install bandit
- name: π¦ Install dependencies (wrknv)
if: inputs.use-wrknv
run: uv sync --all-groups ${{ inputs.no-sources && '--no-sources' || '' }}
# No pip-audit here either: `--python .venv/bin/python` is the same
# install into the audited environment, spelled differently.
- name: π§ Install wrknv
if: inputs.use-wrknv
run: uv pip install --python .venv/bin/python "wrknv @ git+https://github.com/provide-io/wrknv.git@main"
# uv silently ignores an override for a package nothing depends on, so a
# mistyped or misnamed pin would otherwise produce a green run against
# unpinned code. This reads the lockfile and insists the pin is in it.
- name: π Verify branch pins took effect
uses: ./.ci-tooling/actions/verify-pins
with:
pins: ${{ steps.pins.outputs.pins }}
- name: π Run Bandit security scan
if: ${{ !inputs.use-wrknv }}
run: |
source .venv/bin/activate
.ci-tooling/scripts/security/run-bandit.sh src/ bandit-report.json -ll
- name: π Run Bandit (wrknv)
if: inputs.use-wrknv
run: .venv/bin/we run security
# Audits the resolved lock, with pip-audit run from `uvx` so the scanner
# is not part of what it reports on. No virtualenv is activated: reading
# the lock does not need one, and not having one is the point.
- name: π Check for known vulnerabilities
run: .ci-tooling/scripts/security/run-pip-audit.sh pip-audit-report.json ${{ inputs.fail-on-vulnerability }} '${{ inputs.ignore-vulnerabilities }}'
- name: π€ Upload security reports
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
if: always()
with:
name: security-reports
path: |
bandit-report.json
pip-audit-report.json
# ==================================================================================
# π Secret Scanning
# ==================================================================================
secret-scan:
name: π Secret Scan
needs: quality
if: inputs.run-secret-scan && github.actor != 'nektos/act'
runs-on: ubuntu-24.04
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
- name: π TruffleHog Scan
uses: trufflesecurity/trufflehog@main
with:
extra_args: --only-verified
continue-on-error: true
- name: π Gitleaks Scan
uses: gitleaks/gitleaks-action@ff98106e4c7b2bc287b24eaf42907196329070c7 # v2.3.9
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
continue-on-error: true
# ==================================================================================
# π¦ Build Package
# ==================================================================================
build:
name: π¦ Build
needs: [test, test-linux-arm, test-macos-arm, test-macos-intel]
if: always() && (needs.test.result == 'success' || needs.test.result == 'skipped')
runs-on: ubuntu-24.04
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ inputs.python-version }}
- name: β‘ Install UV
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
with:
version: ${{ inputs.uv-version }}
enable-cache: false # Build doesn't need cache, just runs uv build
- name: π¦ Build Package
run: uv build
- name: π€ Upload Dist Artifacts
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
with:
name: dist
path: dist/
# ==================================================================================
# π CI Summary
# ==================================================================================
# ==================================================================================
# π Unpinned-merge check
# ==================================================================================
pins-clean:
name: π No Active Pins
# Deliberately a separate job. The test jobs run *with* the pins and should go
# green -- that is what pinning is for. This one stays red until the pin is
# gone, so branch protection has something to block the merge on.
#
# It has no `if:` on purpose. A required status check that never reports is
# pending forever, so a job that vanished when block-merge-on-pins was turned
# off would wedge every pull request in the repository. Instead it always
# runs, and the input decides whether an active pin is an error or a warning.
runs-on: ubuntu-24.04
steps:
- name: π₯ Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: π₯ Checkout ci-tooling
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with: