-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathflowzone.yml
5046 lines (4377 loc) · 184 KB
/
flowzone.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
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
.flowzone:
- &ifInternalPullRequest # check if the PR is from a fork by comparing the repository name
if: github.event.pull_request.head.repo.full_name == github.repository
- &ifExternalPullRequest # check if the PR is from a fork by comparing the repository name
if: github.event.pull_request.head.repo.full_name != github.repository
- &ifPrivateRepository
if: github.event.repository.private
- &ifPublicRepository
if: github.event.repository.private != true
- &getGitHubAppToken # https://github.com/tibdex/github-app-token
name: Generate GitHub App installation token
uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # v2.1.0
if: inputs.app_id
id: gh_app_token
with: &getGitHubAppTokenWith
app_id: ${{ inputs.app_id }}
installation_retrieval_mode: ${{ inputs.token_retrieval_mode }}
installation_retrieval_payload: ${{ inputs.token_retrieval_payload }}
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
permissions: >-
{
"contents": "read",
"metadata": "read"
}
# optionally attempt to get AWS login short-lived session credentials over OIDC
- &configureAWSCredentials # https://github.com/aws-actions/configure-aws-credentials
name: Configure AWS credentials
id: aws_credentials
uses: aws-actions/configure-aws-credentials@ececac1a45f3b08a01d2dd070d28d111c5fe6722 # v4.1.0
# skip if the PR is from a fork or aws region is unset
if: |
( matrix.region != '' || inputs.aws_region != '' ) &&
github.event.pull_request.head.repo.full_name == github.repository
continue-on-error: true
with:
role-to-assume: ${{ matrix.role || inputs.aws_iam_role }}
role-session-name: github-${{ github.job }}-${{ github.run_id }}-${{ github.run_attempt }}
aws-region: ${{ matrix.region || inputs.aws_region }}
# https://github.com/orgs/community/discussions/26636#discussioncomment-3252664
mask-aws-account-id: false
- &generatePythonMetadata
name: Generate Python metadata
id: python_meta
run: |
package="$(poetry version --no-ansi | awk '{print $1}')"
version="$(poetry version --no-ansi | awk '{print $2}')"
commit_sha="$(echo ${{ github.event.pull_request.head.sha }} | tr "a-z" "A-Z")"
decimal_sha="$(echo "ibase=16; $commit_sha" | bc)"
version_tag="${version}-dev${decimal_sha}"
echo "package=${package}" >> "${GITHUB_OUTPUT}"
echo "version=${version}" >> "${GITHUB_OUTPUT}"
echo "version_tag=${version_tag}" >> "${GITHUB_OUTPUT}"
- &getTimeStamp
name: Get and format timestamp
id: timestamp
env:
FORMAT: "%Y-%m-%d-%H%M%S"
run: |
echo "datetime=$(date +"${FORMAT}")" >> $GITHUB_OUTPUT
# https://octokit.github.io/rest.js/v21/#git-create-tag
# https://docs.github.com/en/rest/git/tags#create-a-tag-object
- &createTagObject
name: Create tag object
id: create_tag
env:
TAG: ${{ steps.versionist.outputs.tag }}
MESSAGE: ${{ steps.versionist.outputs.tag }}
SHA: ${{ steps.create_commit.outputs.sha }}
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
result-encoding: json
script: |
const { data: tag } = await github.rest.git.createTag({
...context.repo,
tag: process.env.TAG,
message: process.env.MESSAGE,
object: process.env.SHA,
type: 'commit'
});
core.setOutput('sha', tag.sha);
return tag;
# https://octokit.github.io/rest.js/v21/#git-update-ref
# https://docs.github.com/en/rest/git/refs#update-a-reference
# remove any refs/ prefix from the ref
- &updateGitReference
name: Update git reference (force)
env:
REF: "heads/${{ github.base_ref }}"
SHA: ${{ steps.create_commit.outputs.sha }}
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
result-encoding: json
script: |
const { data: ref } = await github.rest.git.updateRef({
...context.repo,
ref: process.env.REF.replace(/^refs\//, ''),
sha: process.env.SHA,
force: true
});
return ref;
# https://octokit.github.io/rest.js/v21/#git-create-ref
# https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#create-a-reference
- &createGitReference
name: Create git reference
env:
REF: "refs/tags/${{ steps.versionist.outputs.tag }}"
SHA: ${{ steps.create_tag.outputs.sha }}
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
result-encoding: json
script: |
const { data: ref } = await github.rest.git.createRef({
...context.repo,
ref: process.env.REF,
sha: process.env.SHA
});
return ref;
- &checkoutAuth
token: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
persist-credentials: false
- &checkoutPullRequestMergeRef
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
# https://github.com/actions/checkout
name: Checkout pull request merge ref
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
submodules: "recursive"
ref: "refs/pull/${{ github.event.number }}/merge"
<<: *checkoutAuth
- &checkoutPullRequestHeadSha
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
# https://github.com/actions/checkout
name: Checkout pull request head sha
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
submodules: "recursive"
# fallback to an invalid ref if the checkout ref is undefined
ref: ${{ github.event.pull_request.head.sha || '¯\_(ツ)_/¯' }}
<<: *checkoutAuth
- &checkoutEventSha
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
# https://github.com/actions/checkout
name: Checkout ${{ github.sha }}
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
submodules: "recursive"
# fallback to an invalid ref if the checkout ref is undefined
ref: ${{ github.sha || '¯\_(ツ)_/¯' }}
<<: *checkoutAuth
- &checkoutVersionedSha # https://github.com/actions/checkout
name: Checkout versioned commit
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: "${{ needs.versioned_source.outputs.depth || 0 }}"
# Note that fetch-tags is not currently working as described:
# https://github.com/actions/checkout/issues/1781
fetch-tags: true
submodules: "recursive"
# fallback to an invalid ref if the checkout ref is undefined
ref: "${{ needs.versioned_source.outputs.sha || '¯\_(ツ)_/¯' }}"
<<: *checkoutAuth
- &shallowCheckout # https://github.com/actions/checkout
name: Checkout source
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
# Disable submodules and deep cloning.
fetch-depth: 1
submodules: false
# Do not persist credentials.
persist-credentials: false
# Use the automatic actions token with contents:read permissions
token: ${{ github.token }}
# Use the tip of the pull request branch for pull request (target) events.
# Use the event sha for other events.
ref: ${{ github.event.pull_request.head.sha || github.sha }}
- &resetGitHubDirectory
# checkout the tip of BASE if the PR is from a fork
# or the merge commit if the PR is internal
name: Reset .github directory to ${{ github.ref }}
env:
GIT_AUTH_TOKEN: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
# Use bash without tracing to avoid leaking secrets
shell: bash
# Create base64 encoded auth header
#
# Use git-c for non-persistent credential configuration
#
# The git -c option sets a configuration value for a single Git command invocation.
# It does not modify any configuration files or persist the setting beyond this specific command.
#
# This approach ensures that the authentication credentials are used securely for this
# specific operation without risk of unintended persistence or exposure in configuration files.
run: |
auth_header=$(printf "x-access-token:${GIT_AUTH_TOKEN}" | base64 | tr -d '\n')
git -c "http.https://github.com/.extraheader=Authorization: basic ${auth_header}" fetch origin ${{ github.ref }}
git checkout FETCH_HEAD -- .github
# Resolve tag, semver, sha, and description of current git working copy.
# tag is the latest tag that points to the current commit.
# semver is the semantic version of the tag.
# describe is the output of `git describe --tags --always --dirty`.
# sha is the full commit hash.
# depth is set to a default number of commits to fetch on downstream jobs
# (enough to get last two tags, or 0 for all commits when submodules are present)
- &describeGitState
name: Describe git state
id: git_describe
run: |
tag="$(git tag --points-at HEAD | tail -n1)"
{
echo "tag=${tag}" ;
echo "semver=$(npx -q -y -- semver -c -l "${tag}")" ;
echo "describe=$(git describe --tags --always --dirty | cat)" ;
echo "sha=$(git rev-parse HEAD)" ;
} >> "${GITHUB_OUTPUT}"
if [[ "$(git submodule)" = "" ]]; then
echo "depth=1" >> "${GITHUB_OUTPUT}"
else
echo "depth=0" >> "${GITHUB_OUTPUT}"
fi
# Create a local reference for the versioned tag so that it
# may be consumed by build steps that need to know the version of the source.
# These refs should already exist on merge/finalize.
- &createLocalRefs
name: Create local tag for draft version
if: github.event.pull_request.state == 'open' && inputs.disable_versioning != true
run: |
git update-ref refs/tags/${{ needs.versioned_source.outputs.tag }} ${{ needs.versioned_source.outputs.tag_sha }}
- &loginWithDockerHub
name: Login to Docker Hub
continue-on-error: true
uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
with:
registry: docker.io
username: ${{ secrets.DOCKERHUB_USER || secrets.DOCKER_REGISTRY_USER }}
password: ${{ secrets.DOCKERHUB_TOKEN || secrets.DOCKER_REGISTRY_PASS }}
- &loginWithGitHubContainerRegistry
name: Login to GitHub Container Registry
continue-on-error: true
uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
with:
# Feb 2023: as per GitHub support: "You cannot authenticate with a GitHub App token on the GitHub Package Registry"
# Nov 2024: Still cannot use GitHub App Tokens to authenticate with the GitHub Package Registry (login works, push/pull fails)
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- &loginWithECRPublic
name: Login to AWS/ECR (public)
if: steps.aws_credentials.outcome == 'success'
continue-on-error: true
uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
with:
registry: public.ecr.aws
- &loginWithECRPrivate
name: Login to AWS/ECR (private)
if: steps.aws_credentials.outcome == 'success'
continue-on-error: true
uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
with:
registry: ${{ matrix.image }}
- &customWorkingDirectory
defaults:
run:
working-directory: ${{ inputs.working_directory }}
shell: bash --noprofile --norc -eo pipefail -x {0}
- &rootWorkingDirectory
defaults:
run:
working-directory: .
shell: bash --noprofile --norc -eo pipefail -x {0}
- &gitHubCliEnvironment
# environment variables used by gh CLI
# https://cli.github.com/manual/gh_help_environment
GH_DEBUG: "true"
GH_PAGER: "cat"
GH_PROMPT_DISABLED: "true"
GH_REPO: "${{ github.repository }}"
- &rejectExternalCustomActions
name: Reject external custom actions
if: |
github.event.pull_request.state == 'open' &&
github.event.pull_request.head.repo.full_name != github.repository &&
inputs.restrict_custom_actions == true
run: |
echo "::error::Custom actions are disabled for external contributors and will be skipped. \
Please contact a member of the organization for assistance."
exit 1
- &logGitHubContext
name: Log GitHub context
env:
GITHUB_CONTEXT: ${{ toJSON(github) }}
run: echo "${GITHUB_CONTEXT}" || true
- &deleteDraftGitHubRelease
name: Delete draft GitHub release
run: gh release delete --yes "${GITHUB_HEAD_REF}" || true
env:
<<: *gitHubCliEnvironment
GH_TOKEN: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
- &jsonArrayBuilder
name: Build JSON list from comma-separated input
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
result-encoding: json
script: |
// Remove whitespace from input
const input = process.env.INPUT?.replace(/\s+/g, '') || '';
// Split by delimiter (will return [''] for empty input)
return !input ? [''] : input.split(',');
- &newlineListBuilder
name: Build newline-separated list from JSON list input
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
result-encoding: string
script: |
return JSON.parse(process.env.INPUT).join('\n');
- &dockerPlatformSlugMap
PLATFORM_SLUG_MAP: >
{
"linux/386": "i386",
"linux/amd64": "amd64",
"linux/arm64": "arm64v8",
"linux/arm/v7": "arm32v7",
"linux/arm/v6": "arm32v6",
"linux/arm/v5": "arm32v5",
"linux/s390x": "s390x",
"linux/mips64le": "mips64le",
"linux/ppc64le": "ppc64le",
"linux/riscv64": "riscv64",
"windows/amd64": "windows-amd64"
}
- &sanitizeDockerStrings
name: Sanitize docker strings
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
id: strings
env:
TARGET: ${{ matrix.target }}
IMAGE: ${{ matrix.image }}
DOCKER_INVERT_TAGS: ${{ inputs.docker_invert_tags }}
with:
result-encoding: json
script: |
const target = process.env.TARGET;
const image = process.env.IMAGE;
const invertTags = process.env.DOCKER_INVERT_TAGS === 'true';
// Sanitize target to slug
const targetSlug = target.replace(/[^a-zA-Z0-9]/g, '-');
if (target && !targetSlug) {
core.setFailed(`Unsupported platform: ${target}`);
return;
}
// Set prefix/suffix based on target
let prefixSlug = '';
let suffixSlug = '';
if (target !== 'default') {
if (invertTags) {
prefixSlug = `${targetSlug}-`;
} else {
suffixSlug = `-${targetSlug}`;
}
}
// Process image string
let imageSlug = '';
let repoSlug = '';
if (image) {
if (image.includes('.')) {
// tl.d/org/repo(:tag)? -> tl.d/org/repo
imageSlug = image.split(':')[0];
} else {
// org/repo(:tag)? -> docker.io/org/repo
imageSlug = `docker.io/${image.split(':')[0]}`;
}
// tl.d/org/repo -> org/repo
repoSlug = imageSlug.split('/').slice(1).join('/');
}
core.setOutput('image', imageSlug)
core.setOutput('target', targetSlug)
core.setOutput('prefix', prefixSlug)
core.setOutput('suffix', suffixSlug)
core.setOutput('repo', repoSlug)
- &dockerTestMetadata # https://github.com/docker/metadata-action
name: Generate docker metadata
id: test_meta
uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0
with:
images: |
sut
localhost:5000/sut
${{ needs.is_docker.outputs.docker_images_crlf }}
labels: &dockerMetaLabels |
org.opencontainers.image.version=${{ needs.versioned_source.outputs.semver }}
org.opencontainers.image.ref.name=${{ matrix.target }}
# These are just local convenience tags, not pushed to any registry.
# They can be referenced in docker compose tests to avoid rebuilding images that should be tested as-is.
# They are ALSO used to populate an additional cache-from source list in case the GHA cache is expired.
# It doesn't matter if the tags in the list don't exist, the cache source will be skipped and continue the build.
tags: |
type=raw,value=latest
type=raw,value=latest,prefix=${{ steps.strings.outputs.prefix }},suffix=${{ steps.strings.outputs.suffix }}
type=raw,value=${{ github.base_ref || github.ref_name }},prefix=${{ steps.strings.outputs.prefix }},suffix=${{ steps.strings.outputs.suffix }}
type=raw,value=${{ github.event.pull_request.head.sha }},prefix=${{ steps.strings.outputs.prefix }},suffix=${{ steps.strings.outputs.suffix }}
type=raw,value=build-${{ github.event.pull_request.head.sha }},prefix=${{ steps.strings.outputs.prefix }},suffix=${{ steps.strings.outputs.suffix }}
type=raw,value=build-${{ github.event.pull_request.head.ref }},prefix=${{ steps.strings.outputs.prefix }},suffix=${{ steps.strings.outputs.suffix }}
flavor: |
latest=false
- &dockerDraftMetadata # https://github.com/docker/metadata-action
<<: *dockerTestMetadata
id: draft_meta
with:
images: |
${{ matrix.image }}
labels: *dockerMetaLabels
tags: |
type=raw,value=${{ github.base_ref || github.ref_name }}
type=raw,value=${{ github.event.pull_request.head.sha }}
type=raw,value=build-${{ github.event.pull_request.head.sha }}
type=raw,value=build-${{ github.event.pull_request.head.ref }}
flavor: |
latest=false
prefix=${{ steps.strings.outputs.prefix }}
suffix=${{ steps.strings.outputs.suffix }}
- &dockerFinalMetadata # https://github.com/docker/metadata-action
<<: *dockerTestMetadata
id: final_meta
with:
images: |
${{ matrix.image }}
labels: *dockerMetaLabels
# for unversioned merges we will use the base branch as the tag
# and version tag and semver will be empty
tags: |
type=raw,value=${{ github.base_ref || github.ref_name }}
type=raw,value=${{ needs.versioned_source.outputs.tag }}
type=raw,value=${{ needs.versioned_source.outputs.semver }}
flavor: |
latest=${{ needs.versioned_source.outputs.semver != '' }}
prefix=${{ steps.strings.outputs.prefix }},onlatest=true
suffix=${{ steps.strings.outputs.suffix }},onlatest=true
- &rejectMissingSecrets
name: Reject missing secrets
run: |
if [ -z '${{ secrets.FLOWZONE_TOKEN }}${{ secrets.GH_APP_PRIVATE_KEY }}' ]
then
echo '::error::Must specify either GH_APP_PRIVATE_KEY or FLOWZONE_TOKEN.'
false
fi
- &rejectFailedJobs
name: Reject failed jobs
run: |
if [ "${{ contains(needs.*.result, 'failure') }}" = "true" ]
then
echo "One or more jobs have failed"
exit 1
fi
- &rejectCancelledJobs
name: Reject cancelled jobs
run: |
if [ "${{ contains(needs.*.result, 'cancelled') }}" = "true" ]
then
echo "One or more jobs were cancelled"
exit 1
fi
- &rejectExternalPullRequest
name: Reject external pull_request events on pull_request
if: |
github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.full_name != github.repository
run: |
echo "::error::External workflows can not be used with 'pull_request' events. \
Please contact a member of the organization for assistance."
exit 1
- &rejectInternalPullRequestTarget
name: Reject internal pull_request events on pull_request_target
if: |
github.event_name == 'pull_request_target' &&
github.event.pull_request.head.repo.full_name == github.repository
run: |
echo "::error::Internal workflows should not be used with 'pull_request_target' events. \
Please consult the documentation for more information."
exit 1
- &rejectNonLinearHead
# This can happen when a PR is updated with a merge commit from main, rather than rebased on main.
# In the GitHub UI this is represented by the "Update with merge commit" option vs "Update with rebase".
# https://github.com/actions/github-script
# https://octokit.github.io/rest.js/v21/#pulls-list-commits
name: Reject HEAD branches containing merge commits
if: github.event.pull_request.state == 'open'
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
result-encoding: json
script: |
const { data: commits } = await github.rest.pulls.listCommits({
...context.repo,
pull_number: context.payload.pull_request.number
});
if (commits.some(({ parents }) => parents.length > 1)) {
throw new Error('Non-linear history detected - merge commit(s) identified in HEAD branch');
}
- &rejectNonLinearMerge
# This can happen if multiple PRs are merged at the same time, typically because
# one PR is rebased on another PR before merging, where the merge commit in the BASE
# branch does not include the tip of the HEAD branch as a parent.
# https://github.com/actions/github-script
# https://octokit.github.io/rest.js/v21/#repos-get-commit
name: Reject merge commits that do not include the HEAD commit as a parent
# This check passes when the PR is open too, but only on pull_request events and not pull_request_target.
# So only check on merged PRs where the HEAD sha should always be a parent of the merge commit.
if: github.event.pull_request.merged
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ steps.gh_app_token.outputs.token || secrets.FLOWZONE_TOKEN }}
result-encoding: json
script: |
console.debug(`Merge commit SHA: ${context.sha}`)
console.debug(`HEAD commit SHA: ${context.payload.pull_request.head.sha}`)
const { data: commit } = await github.rest.repos.getCommit({
...context.repo,
ref: context.sha
});
console.debug('Commit parents: %s', JSON.stringify(commit.parents, null, 2))
if (!commit.parents.some(({ sha }) => sha === context.payload.pull_request.head.sha)) {
throw new Error('Non-linear history detected - HEAD branch commit is not a parent of the merge commit');
}
- &setupBuildx # https://github.com/docker/setup-buildx-action
name: Setup buildx
id: setup_buildx
uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0
env:
# renovate: datasource=github-releases depName=docker/buildx
BUILDX_VERSION: v0.23.0
with:
driver-opts: network=host
install: true
version: ${{ env.BUILDX_VERSION }}
- &setupQemuBinfmt # https://github.com/docker/setup-qemu-action
name: Setup QEMU
id: qemu_binfmt
uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
env:
LOG_LEVEL: debug
# renovate: datasource=docker depName=tonistiigi/binfmt versioning=regex:^(?<compatibility>.*)-v(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)-(?<build>\d+)$
BINFMT_VERSION: qemu-v9.2.2-52
with:
platforms: ${{ matrix.platform }}
# https://hub.docker.com/r/tonistiigi/binfmt
image: tonistiigi/binfmt:${{ env.BINFMT_VERSION }}
- &setupNode # https://github.com/actions/setup-node
name: Setup Node.js
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
env:
# renovate: datasource=node-version depName=node packageName=node-20.x
NODE_VERSION: 20.19.1
with:
node-version: ${{ env.NODE_VERSION }}
- &setupCrane # https://github.com/imjasonh/setup-crane
name: Setup crane
uses: imjasonh/setup-crane@31b88efe9de28ae0ffa220711af4b60be9435f6e # v0.4
with:
version: v0.14.0
- &setupPython # https://github.com/actions/setup-python
name: Setup python
id: setup-python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: "3.13"
- &setupPoetry # https://github.com/abatilo/actions-poetry
name: Setup poetry
if: steps.setup-python.outputs.python-version != ''
uses: abatilo/actions-poetry@3765cf608f2d4a72178a9fc5b918668e542b89b1 # v4.0.0
with:
poetry-version: "1.5.1"
- &setupSkopeo # https://github.com/product-os/setup-skopeo-action
name: Setup skopeo
uses: product-os/setup-skopeo-action@5a3989811388c16b01f29554996e0c7e802b410b # v0.0.2
with:
# https://github.com/lework/skopeo-binary/releases
version: "v1.15.0"
- &setupAwsCli
name: Setup AWS CLI
uses: product-os/setup-awscli-action@b5e9d5a0afb5b62fb8fb8bb079dcd84354cef03d # v0.0.13
with:
version: "2.15.43"
- &waitForCloudFormation
name: Wait for resources
run: |
stack_status="$(aws cloudformation describe-stacks \
--stack-name '${{ matrix.stack }}' --output text --query Stacks[*].StackStatus || true)"
if [[ -n "$stack_status" ]]; then
aws cloudformation wait stack-exists --stack-name '${{ matrix.stack }}'
if [[ "$stack_status" =~ CREATE_IN_PROGRESS ]]; then
aws cloudformation wait stack-create-complete --stack-name '${{ matrix.stack }}'
fi
if [[ "$stack_status" =~ UPDATE_IN_PROGRESS ]]; then
aws cloudformation wait stack-update-complete --stack-name '${{ matrix.stack }}'
fi
if [[ "$stack_status" =~ ROLLBACK_IN_PROGRESS ]]; then
aws cloudformation wait stack-rollback-complete --stack-name '${{ matrix.stack }}'
fi
aws cloudformation describe-stacks --stack-name '${{ matrix.stack }}'
fi
- &getAWSCallerIdentity
name: Get caller identity (AWS/whoami)
if: steps.aws_credentials.outcome == 'success'
continue-on-error: true
run: aws sts get-caller-identity
- &updateKubeconfig
name: Update kubeconfig
run: |
aws eks update-kubeconfig --name "$(echo "${KUBE_CTX}" | awk -F'/' '{print $2}')"
- &publishSBOMArtifacts
name: Publish SBOM artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
- &publishSBOMToDependencyTrack
name: Publish SBOM To Dependency Track
if: ${{ env.SERVER_HOSTNAME != '' }}
run: |
curl -X "PUT" "https://${{ env.SERVER_HOSTNAME }}/api/v1/bom" \
-H 'Content-Type: application/json' \
-H 'X-API-Key: ${{env.API_KEY}}' \
-d '{
"projectName": "'"${{env.PROJECT_NAME}}"'",
"projectVersion": "'"${{env.PROJECT_VERSION}}"'",
"autoCreate": "true",
"bom": "'"$(base64 -w 0 "${{ env.BOM_FILE }}")"'"
}'
- &convenienceFunctions
name: Convenience functions
id: functions
run: |
# shellcheck disable=SC2034
EOF="$(openssl rand -hex 16)"
# https://sre.google/sre-book/addressing-cascading-failures/
with_backoff="$(mktemp)"
cat << $EOF > "${with_backoff}"
function with_backoff() {
local max_attempts=\${ATTEMPTS-3}
local timeout=\${TIMEOUT-2}
local attempt=0
local exitCode=0
set +e
while [[ \$attempt < \$max_attempts ]]; do
"\$@"
exitCode=\$?
[[ \$exitCode == 0 ]] && break
echo "Failure! Retrying in \$timeout.." 1>&2
sleep "\$timeout"
attempt=\$(( attempt + 1 ))
timeout=\$(( timeout * 2 ))
done
[[ \$exitCode != 0 ]] && echo "You've failed me for the last time! (\$*)" 1>&2
set -e
return \$exitCode
}
$EOF
echo "with_backoff=${with_backoff}" >> "${GITHUB_OUTPUT}"
- &randomDelay
name: Random delay
run: |
DELAY="${DELAY-5}"
random="$(((RANDOM % DELAY) + 1))"
echo "sleeping for ${random}s"
sleep "${random}s"
name: Flowzone
on:
workflow_call:
secrets:
# https://github.com/organizations/product-os/settings/secrets/actions/GH_APP_PRIVATE_KEY
GH_APP_PRIVATE_KEY:
description: "GitHub App to generate ephemeral access tokens"
required: false
FLOWZONE_TOKEN:
description: ".. or Personal Access Token (PAT) with admin/owner permissions in the org."
required: false
NPM_TOKEN:
description: "The npm auth token to use for publishing"
required: false
DOCKERHUB_USER:
description: "Username to publish to the Docker Hub container registry"
required: false
DOCKER_REGISTRY_USER:
description: "Deprecated, use DOCKERHUB_USER instead"
required: false
DOCKERHUB_TOKEN:
description: "A personal access token to publish to the Docker Hub container registry"
required: false
DOCKER_REGISTRY_PASS:
description: "Deprecated, use DOCKERHUB_TOKEN instead"
required: false
BALENA_API_KEY:
description: "API key for pushing releases to balena applications"
required: false
BALENA_API_KEY_PUSH:
description: "Deprecated, use BALENA_API_KEY instead"
required: false
CARGO_REGISTRY_TOKEN:
description: "A personal access token to publish to a cargo registry"
required: false
COMPOSE_VARS:
description: "Optional base64 encoded docker-compose `.env` file for testing Docker images"
required: false
CF_ACCOUNT_ID:
description: "Cloudflare account ID"
required: false
CF_API_TOKEN:
description: "Cloudflare API token with limited access for Pages projects"
required: false
PYPI_TOKEN:
description: "Token to publish to pypi.org"
required: false
PYPI_TEST_TOKEN:
description: "Token to publish to test.pypi.org"
required: false
ZULIP_API_KEY:
description: "API key to post Zulip messages."
required: false
CUSTOM_JOB_SECRET_1:
description: "Optional secret for using with custom jobs"
required: false
CUSTOM_JOB_SECRET_2:
description: "Optional secret for using with custom jobs"
required: false
CUSTOM_JOB_SECRET_3:
description: "Optional secret for using with custom jobs"
required: false
DTRACK_TOKEN:
description: "API key for Dependency-Track integration"
required: false
inputs:
aws_region:
description: "AWS region with GitHub OIDC provider IAM configuration"
type: string
required: false
default: "${{ vars.AWS_REGION || '' }}"
aws_iam_role:
description: "AWS IAM role ARN to assume with GitHub OIDC provider"
type: string
required: false
default: "${{ vars.AWS_IAM_ROLE || '' }}"
cloudformation_templates:
description: |
This input is deprecated. To deploy CloudFormation stacks, create a `aws-cf-templates.yaml` file in the root of the repository.
type: string
required: false
default: ""
app_id:
description: >-
GitHub App ID to generate an installation token.
See https://github.com/tibdex/github-app-token for more info.
type: string
required: false
default: "${{ vars.FLOWZONE_APP_ID || vars.APP_ID }}"
token_retrieval_mode:
description: >-
The mode used to retrieve the installation for which the token will be requested.
One of 'id', 'organization', 'repository', 'user'.
See https://github.com/tibdex/github-app-token for more info.
type: string
required: false
default: organization
token_retrieval_payload:
description: >-
The payload used to retrieve the installation token, based on the token retrieval mode.
See https://github.com/tibdex/github-app-token for more info.
type: string
required: false
default: ${{ github.repository_owner }}
token_scope:
description: "Ephemeral token scope(s)"
type: string
required: false
# https://github.com/organizations/product-os/settings/installations/34040165
# https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#create-a-scoped-access-token
default: >-
{
"contents": "write",
"metadata": "read",
"packages": "write",
"pages": "write",
"pull_requests": "read"
}
jobs_timeout_minutes:
description: "Timeout for the job(s)."
type: number
required: false
default: 360
working_directory:
description: "GitHub actions working directory"
type: string
required: false
default: "."
docker_images:
description: "Comma-delimited string of Docker images (without tags) to publish (skipped if empty)"
type: string
required: false
default: ""
bake_targets:
description: "Comma-delimited string of Docker buildx bake targets to publish (skipped if empty)"
type: string
required: false
default: "default"
docker_invert_tags:
description: "Invert the tags for the Docker images (e.g. `{tag}-{variant}` becomes `{variant}-{tag}`)"
type: boolean
required: false
default: false
docker_publish_platform_tags:
description: "Publish platform-specific tags in addition to multi-arch manifests (e.g. `product-os/flowzone:latest-amd64`)"
type: boolean
required: false
default: false
balena_environment:
description: "balenaCloud environment"
type: string
required: false
default: balena-cloud.com
balena_slugs:
description: "Comma-delimited string of balenaCloud apps, fleets, or blocks to deploy (skipped if empty)"
type: string
required: false
default: ""
cargo_targets:
description: "Comma-delimited string of Rust stable targets to publish (skipped if empty)"
type: string
required: false
default: |
aarch64-unknown-linux-gnu,
armv7-unknown-linux-gnueabihf,
arm-unknown-linux-gnueabihf,
x86_64-unknown-linux-gnu,
i686-unknown-linux-gnu
rust_toolchain:
description: "Version specifier (e.g. 1.65, stable, nigthly) for the toolchain to use when building Rust sources"
type: string
required: false
default: stable
rust_binaries:
description: "Set to true to publish Rust binary release artifacts to GitHub"
type: boolean
required: false
default: false
pseudo_terminal:
description: "Set to true to enable terminal emulation for test steps"
type: boolean
required: false
default: false
disable_versioning:
description: "Set to true to disable automatic versioning"
type: boolean
required: false
default: false
runs_on:
description: "JSON array of runner label strings for default jobs."
type: string
required: false
default: >
[
"ubuntu-24.04"
]
docker_runs_on:
description: "JSON key-value pairs mapping platforms to arrays of runner labels. Unlisted platforms will use `runs_on`."
type: string
required: false
default: >
{
"linux/amd64": ["ubuntu-24.04"],
"linux/arm64": ["ubuntu-24.04-arm"],
"linux/arm/v7": ["ubuntu-24.04-arm"],
"linux/arm/v6": ["ubuntu-24.04-arm"]
}
cloudformation_runs_on:
description: "JSON array of runner label strings for cloudformation jobs."
type: string
required: false
cloudflare_website:
description: "Setting this to your existing CF pages project name will generate and deploy a website. Skipped if empty."
type: string
required: false
default: ""
docusaurus_website:
description: "Set to false to disable building a docusaurus website. If false the script `npm run deploy-docs` will be run if it exists."
type: boolean
required: false
default: true
github_prerelease:
description: "Finalize releases on merge."
type: boolean
required: false
default: false
restrict_custom_actions:
description: "Do not execute custom actions for external contributors. Only remove this restriction if custom actions have been vetted as secure."
type: boolean
required: false
default: true
custom_test_matrix:
description: "JSON matrix strategy for the custom test action. Properties 'environment' and 'os' will be applied to the job."
type: string
required: false
default: ""
custom_publish_matrix:
description: "JSON matrix strategy for the custom publish action. Properties 'environment' and 'os' will be applied to the job."
type: string
required: false
default: ""
custom_finalize_matrix:
description: "JSON matrix strategy for the custom finalize action. Properties 'environment' and 'os' will be applied to the job."
type: string
required: false
default: ""