Repository navigation
1401 lines (1332 loc) · 62.9 KB
/
Copy pathbake.yml
File metadata and controls
1401 lines (1332 loc) · 62.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: bake
on:
workflow_call:
inputs:
runner:
type: string
description: "GitHub-hosted Linux runner label or platform mapping to build on"
required: false
default: |
default=ubuntu-24.04
linux/arm=ubuntu-24.04-arm
linux/arm64=ubuntu-24.04-arm
distribute:
type: boolean
description: "Whether to distribute the build across multiple runners (one platform per runner)"
required: false
default: true
fail-fast:
type: boolean
description: "Whether to cancel all in-progress and queued jobs in the matrix if any job fails"
required: false
default: false
job-name-prefix:
type: string
description: "Prefix to include in reusable workflow job matrix names in the GitHub Actions UI"
required: false
setup-qemu:
type: boolean
description: "Runs the setup-qemu-action step to install QEMU static binaries"
required: false
default: false
artifact-name:
type: string
description: "Name of the uploaded GitHub artifact (for local output)"
required: false
default: 'docker-github-builder-assets'
artifact-upload:
type: boolean
description: "Upload build output GitHub artifact (for local output)"
required: false
default: false
artifact-retention-days:
type: number
description: "Duration after which artifact will expire in days. 0 means using default retention."
required: false
default: 0
cache:
type: boolean
description: "Enable cache to GitHub Actions cache backend"
required: false
default: false
cache-scope:
type: string
description: "Which scope cache object belongs to if cache enabled (defaults to target name)"
required: false
cache-mode:
type: string
description: "Cache layers to export if cache enabled (min or max)"
required: false
default: 'min'
context:
type: string
description: "Context to build from in the Git working tree"
required: false
default: .
files:
type: string
description: "List of bake definition files"
required: false
output:
type: string
description: "Build output destination (one of image or local). Unlike the build-push-action, it only accepts image or local. The reusable workflow takes care of setting the outputs attribute"
required: true
push:
type: boolean
description: "Push image to the registry (for image output)"
required: false
default: false
registry-login:
type: string
description: "Login to registry before build (one of auto, true or false). Auto enables login only when output is image and push is true"
required: false
default: auto
sbom:
type: boolean
description: "Generate SBOM attestation for the build"
required: false
default: false
set:
type: string
description: "List of targets values to override (eg. targetpattern.key=value)"
required: false
sign:
type: string
description: "Sign attestation manifest for image output or artifacts for local output, can be one of auto, true or false. The auto mode will enable signing if push is enabled for pushing the image or if artifact-upload is enabled for uploading the local build output as GitHub Artifact"
required: false
default: auto
target:
type: string
description: "Bake target to build"
required: false
default: default
vars:
type: string
description: "Variables to set in the Bake definition as list of key-value pair"
required: false
registry-identities:
type: string
description: "Keyless registry identity configuration as YAML objects"
required: false
# docker/metadata-action
set-meta-annotations:
type: boolean
description: "Append OCI Image Format Specification annotations generated by docker/metadata-action"
required: false
default: false
set-meta-labels:
type: boolean
description: "Append OCI Image Format Specification labels generated by docker/metadata-action"
required: false
default: false
meta-images:
type: string
description: "List of images to use as base name for tags (required for image output)"
required: false
meta-tags:
type: string
description: "List of tags as key-value pair attributes"
required: false
meta-flavor:
type: string
description: "Flavor defines a global behavior for meta-tags"
required: false
meta-labels:
type: string
description: "List of custom labels"
required: false
meta-annotations:
type: string
description: "List of custom annotations"
required: false
meta-bake-target:
type: string
description: "Bake target name for metadata (defaults to docker-metadata-action)"
required: false
# buildkit config
buildkit-proxy-network:
type: boolean
description: "Enable BuildKit proxy network mode"
required: false
default: false
secrets:
registry-auths:
description: "Raw authentication to registries, defined as YAML objects"
required: false
build-secrets:
description: "YAML object mapping BuildKit secret IDs to values, with optional nested target mappings"
required: false
github-token:
description: "GitHub Token used to authenticate against the repository for Git context"
required: false
outputs:
meta-json:
description: "Metadata JSON output (for image output)"
value: ${{ jobs.finalize.outputs.meta-json }}
cosign-version:
description: "Cosign version used for verification"
value: ${{ jobs.finalize.outputs.cosign-version }}
cosign-verify-commands:
description: "Cosign verify commands"
value: ${{ jobs.finalize.outputs.cosign-verify-commands }}
artifact-name:
description: "Name of the uploaded artifact (for local output)"
value: ${{ jobs.finalize.outputs.artifact-name }}
digest:
description: "Digest of the image pushed or artifact uploaded"
value: ${{ jobs.finalize.outputs.digest }}
output-type:
description: "Build output type"
value: ${{ jobs.finalize.outputs.output-type }}
signed:
description: "Whether attestations manifests or artifacts were signed"
value: ${{ jobs.finalize.outputs.signed }}
env:
BUILDX_VERSION: "v0.38.0"
BUILDKIT_IMAGE: "moby/buildkit:v0.34.0"
SBOM_IMAGE: "docker/buildkit-syft-scanner:1.12.0"
BINFMT_IMAGE: "tonistiigi/binfmt:qemu-v10.2.3-68"
RUNTIME_MODULE: "@docker/github-builder-runtime@0.104.0"
RUNTIME_INSTALL_ARGS: |
--loglevel=error
--no-save
--package-lock=false
--ignore-scripts
--omit=dev
--prefer-offline
--fund=false
--audit=false
COSIGN_VERSION: "v3.1.3"
LOCAL_EXPORT_DIR: "/tmp/buildx-output"
MATRIX_SIZE_LIMIT: "20"
BUILDX_METADATA_PROVENANCE: "false"
BUILDX_SEND_GIT_QUERY_AS_INPUT: "true"
NPM_CONFIG_FETCH_RETRIES: "5"
jobs:
registry-identities:
uses: ./.github/workflows/setup-registry-identities.yml
with:
registry-login: ${{ inputs.registry-login == 'true' || (inputs.registry-login == 'auto' && inputs.push && inputs.output == 'image') }}
registry-identities: ${{ inputs.registry-identities }}
prepare:
runs-on: ubuntu-24.04
strategy:
matrix:
include:
- name: ${{ inputs.job-name-prefix }}
outputs:
includes: ${{ steps.set.outputs.includes }}
metaImages: ${{ steps.set.outputs.metaImages }}
sign: ${{ steps.set.outputs.sign }}
privateRepo: ${{ steps.set.outputs.privateRepo }}
targets: ${{ steps.set.outputs.targets }}
ghaCacheSign: ${{ steps.set.outputs.ghaCacheSign }}
proxyNetwork: ${{ steps.set.outputs.proxyNetwork }}
registryLogin: ${{ steps.set.outputs.registryLogin }}
steps:
-
name: Install dependencies
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_RUNTIME-MODULE: ${{ env.RUNTIME_MODULE }}
INPUT_RUNTIME-INSTALL-ARGS: ${{ env.RUNTIME_INSTALL_ARGS }}
with:
script: |
const npmArgs = ['install', ...core.getMultilineInput('runtime-install-args'), core.getInput('runtime-module')];
const maxAttempts = 3;
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
const exitCode = await exec.exec('npm', npmArgs, {ignoreReturnCode: true});
if (exitCode === 0) {
return;
}
if (attempt === maxAttempts) {
core.setFailed(`npm install failed after ${maxAttempts} attempts`);
return;
}
const retryDelayMs = attempt * 50;
core.info(`npm install failed with exit code ${exitCode}; retrying in ${retryDelayMs}ms`);
await new Promise(resolve => setTimeout(resolve, retryDelayMs));
}
-
name: Install Cosign
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_COSIGN-VERSION: ${{ env.COSIGN_VERSION }}
with:
script: |
const { Cosign } = require('@docker/github-builder-runtime/lib/cosign/cosign');
const { Install } = require('@docker/github-builder-runtime/lib/cosign/install');
const inpCosignVersion = core.getInput('cosign-version');
const cosignInstall = new Install();
const cosignBinPath = await cosignInstall.download({
version: core.getInput('cosign-version'),
ghaNoCache: true,
skipState: true,
verifySignature: true
});
const cosignPath = await cosignInstall.install(cosignBinPath);
const cosign = new Cosign();
await cosign.printVersion();
-
name: Check dependencies signatures
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_IMAGES: |
${{ env.BUILDKIT_IMAGE }}
${{ env.SBOM_IMAGE }}
${{ env.BINFMT_IMAGE }}
with:
script: |
const { OCI } = require('@docker/github-builder-runtime/lib/oci/oci');
const { Sigstore } = require('@docker/github-builder-runtime/lib/sigstore/sigstore');
const sigstore = new Sigstore();
for (const image of core.getMultilineInput('images')) {
try {
await core.group(`Verifying ${image}`, async () => {
await sigstore.verifyImageAttestations(image, {
certificateIdentityRegexp: `^https://github.com/docker/github-builder(-experimental)?/.github/workflows/bake.yml.*$`,
platform: OCI.defaultPlatform()
});
});
} catch (error) {
core.setFailed(`Failed to verify ${image}: ${error.message || error}`);
return;
}
}
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
with:
version: ${{ env.BUILDX_VERSION }}
cache-binary: false
driver-opts: |
image=${{ env.BUILDKIT_IMAGE }}
-
name: Set outputs
id: set
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_SBOM-IMAGE: ${{ env.SBOM_IMAGE }}
INPUT_MATRIX-SIZE-LIMIT: ${{ env.MATRIX_SIZE_LIMIT }}
INPUT_META-IMAGES: ${{ inputs.meta-images }}
INPUT_RUNNER: ${{ inputs.runner }}
INPUT_DISTRIBUTE: ${{ inputs.distribute }}
INPUT_ARTIFACT-UPLOAD: ${{ inputs.artifact-upload }}
INPUT_JOB-NAME-PREFIX: ${{ inputs.job-name-prefix }}
INPUT_CONTEXT: ${{ inputs.context }}
INPUT_FILES: ${{ inputs.files }}
INPUT_OUTPUT: ${{ inputs.output }}
INPUT_PUSH: ${{ inputs.push }}
INPUT_REGISTRY-LOGIN: ${{ inputs.registry-login }}
INPUT_SBOM: ${{ inputs.sbom }}
INPUT_SET: ${{ inputs.set }}
INPUT_SIGN: ${{ inputs.sign }}
INPUT_TARGET: ${{ inputs.target }}
INPUT_VARS: ${{ inputs.vars }}
INPUT_GITHUB-TOKEN: ${{ secrets.github-token || github.token }}
INPUT_BUILDKIT-PROXY-NETWORK: ${{ inputs.buildkit-proxy-network }}
with:
script: |
const os = require('os');
const { Bake } = require('@docker/github-builder-runtime/lib/buildx/bake');
const { Build } = require('@docker/github-builder-runtime/lib/buildx/build');
const { GitHub } = require('@docker/github-builder-runtime/lib/github/github');
const { RunnerMapping } = require('@docker/github-builder-runtime/lib/github-builder/runner-mapping');
const { BakeTargets } = require('@docker/github-builder-runtime/lib/github-builder/bake-targets');
const { Util } = require('@docker/github-builder-runtime/lib/util');
const inpSbomImage = core.getInput('sbom-image');
const inpMatrixSizeLimit = parseInt(core.getInput('matrix-size-limit'), 10);
const inpMetaImages = core.getMultilineInput('meta-images');
const actionsIdTokenSet = !!process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN && !!process.env.ACTIONS_ID_TOKEN_REQUEST_URL;
const inpRunner = core.getMultilineInput('runner');
const inpDistribute = core.getBooleanInput('distribute');
const inpArtifactUpload = core.getBooleanInput('artifact-upload');
const inpJobNamePrefix = core.getInput('job-name-prefix');
const inpContext = core.getInput('context');
const inpVars = Util.getInputList('vars');
const inpFiles = Util.getInputList('files');
const inpOutput = core.getInput('output');
const inpPush = core.getBooleanInput('push');
const inpRegistryLogin = core.getInput('registry-login');
const inpSbom = core.getBooleanInput('sbom');
const inpSet = Util.getInputList('set', {ignoreComma: true, quote: false});
const inpSign = core.getInput('sign');
const inpTarget = core.getInput('target');
const inpGitHubToken = core.getInput('github-token');
const inpProxyNetwork = core.getBooleanInput('buildkit-proxy-network');
let runnerConfig;
try {
runnerConfig = RunnerMapping.parse(inpRunner);
} catch (error) {
core.setFailed(error.message);
return;
}
await core.group(`Set runner config`, async () => {
core.info(JSON.stringify(runnerConfig, null, 2));
});
const sign =
inpSign === 'auto'
? (inpOutput === 'image' && inpPush) || (inpOutput === 'local' && inpArtifactUpload)
: inpSign === 'true';
if (inpOutput === 'local' && inpPush) {
core.warning(`push is ignored when output is local`);
} else if (inpOutput === 'image' && inpArtifactUpload) {
core.warning(`artifact-upload is ignored when output is image`);
}
if (inpOutput === 'image' && !inpPush && sign) {
core.setFailed(`signing attestation manifests requires push to be enabled`);
return;
}
const gitContextAttrs = GitHub.context.ref.startsWith('refs/tags/') ? {checksum: GitHub.context.sha} : {'fetch-by-commit': 'true'};
const bakeSource = await new Build().gitContext({subdir: inpContext, attrs: gitContextAttrs});
await core.group(`Set bake source`, async () => {
core.info(bakeSource);
});
if (!['auto', 'true', 'false'].includes(inpRegistryLogin)) {
core.setFailed(`Invalid registry-login input: ${inpRegistryLogin}`);
return;
}
const registryLogin = inpRegistryLogin === 'auto' ? inpOutput === 'image' && inpPush : inpRegistryLogin === 'true';
const envs = Object.assign({},
inpVars ? inpVars.reduce((acc, curr) => {
const idx = curr.indexOf('=');
if (idx !== -1) {
acc[curr.substring(0, idx)] = curr.substring(idx + 1);
}
return acc;
}, {}) : {},
{
BUILDKIT_MULTI_PLATFORM: '1',
BUILDX_BAKE_GIT_AUTH_TOKEN: inpGitHubToken
}
);
await core.group(`Set envs`, async () => {
core.info(JSON.stringify(Object.keys(envs).sort(), null, 2));
});
const metaImages = inpMetaImages.map(image => image.toLowerCase());
await core.group(`Set metaImages output`, async () => {
core.info(JSON.stringify(metaImages, null, 2));
core.setOutput('metaImages', metaImages.join('\n'));
});
let def;
let target;
try {
await core.group(`Validating definition`, async () => {
const bake = new Bake();
// Resolve the graph without local secret files. The build job validates
// secrets after applying the workflow-provided source overrides.
const validationOverrides = inpSet.filter(override => {
const key = override.split('=', 1)[0].split('.')[1];
return !['secret', 'secrets', 'secrets+'].includes(key);
});
def = await bake.getDefinition({
files: inpFiles,
overrides: [...validationOverrides, '*.secrets='],
sbom: inpSbom ? `generator=${inpSbomImage}` : 'false',
source: bakeSource,
targets: [inpTarget]
}, {
env: Object.keys(envs).length > 0 ? envs : undefined
});
if (!def) {
throw new Error('Bake definition not set');
}
const targets = BakeTargets.resolve(def, inpTarget);
target = inpTarget;
core.setOutput('targets', JSON.stringify(targets));
});
} catch (error) {
core.setFailed(error);
return;
}
const platforms = def.target[target].platforms || [];
if (inpDistribute && platforms.length > inpMatrixSizeLimit) {
core.setFailed(`Platforms to build exceed matrix size limit of ${inpMatrixSizeLimit}`);
return;
}
const privateRepo = GitHub.context.payload.repository?.private ?? false;
await core.group(`Set privateRepo output`, async () => {
core.info(`privateRepo: ${privateRepo}`);
core.setOutput('privateRepo', privateRepo);
});
await core.group(`Set proxyNetwork output`, async () => {
const proxyNetwork = inpProxyNetwork ? 'true' : 'false';
core.info(`proxyNetwork: ${proxyNetwork}`);
core.setOutput('proxyNetwork', proxyNetwork);
});
await core.group(`Set includes output`, async () => {
const withJobNamePrefix = include => {
if (inpJobNamePrefix) {
return {name: inpJobNamePrefix, ...include};
}
return include;
};
let includes = [];
if (!inpDistribute || platforms.length === 0) {
includes.push(withJobNamePrefix({
index: 0,
runner: RunnerMapping.resolve(runnerConfig)
}));
} else {
platforms.forEach((platform, index) => {
includes.push(withJobNamePrefix({
index: index,
platform: platform,
runner: RunnerMapping.resolve(runnerConfig, platform)
}));
});
}
core.info(JSON.stringify(includes, null, 2));
core.setOutput('includes', JSON.stringify(includes));
});
await core.group(`Set sign output`, async () => {
core.info(`sign: ${sign}`);
core.setOutput('sign', sign);
});
await core.group(`Set ghaCacheSign output`, async () => {
const ghaCacheSign = actionsIdTokenSet ? 'true' : 'false';
core.info(`ghaCacheSign: ${ghaCacheSign}`);
core.setOutput('ghaCacheSign', ghaCacheSign);
});
await core.group(`Set registryLogin output`, async () => {
core.info(`registryLogin: ${registryLogin}`);
core.setOutput('registryLogin', registryLogin);
});
build:
runs-on: ${{ matrix.runner }}
needs:
- registry-identities
- prepare
env:
REGISTRY_AUTHS_PRESENT: ${{ secrets.registry-auths != '' }}
strategy:
fail-fast: ${{ inputs.fail-fast }}
matrix:
include: ${{ fromJson(needs.prepare.outputs.includes) }}
outputs:
# needs predefined outputs as we can't use dynamic ones atm: https://github.com/actions/runner/pull/2477
# 20 is the maximum number of platforms supported by our matrix strategy
result_0: ${{ steps.result.outputs.result_0 }}
result_1: ${{ steps.result.outputs.result_1 }}
result_2: ${{ steps.result.outputs.result_2 }}
result_3: ${{ steps.result.outputs.result_3 }}
result_4: ${{ steps.result.outputs.result_4 }}
result_5: ${{ steps.result.outputs.result_5 }}
result_6: ${{ steps.result.outputs.result_6 }}
result_7: ${{ steps.result.outputs.result_7 }}
result_8: ${{ steps.result.outputs.result_8 }}
result_9: ${{ steps.result.outputs.result_9 }}
result_10: ${{ steps.result.outputs.result_10 }}
result_11: ${{ steps.result.outputs.result_11 }}
result_12: ${{ steps.result.outputs.result_12 }}
result_13: ${{ steps.result.outputs.result_13 }}
result_14: ${{ steps.result.outputs.result_14 }}
result_15: ${{ steps.result.outputs.result_15 }}
result_16: ${{ steps.result.outputs.result_16 }}
result_17: ${{ steps.result.outputs.result_17 }}
result_18: ${{ steps.result.outputs.result_18 }}
result_19: ${{ steps.result.outputs.result_19 }}
steps:
-
name: Require GitHub-hosted Linux runner
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_RUNNER-ENVIRONMENT: ${{ runner.environment }}
INPUT_RUNNER-OS: ${{ runner.os }}
with:
script: |
const runnerEnvironment = core.getInput('runner-environment');
const runnerOS = core.getInput('runner-os');
if (runnerEnvironment !== 'github-hosted' || runnerOS !== 'Linux') {
core.setFailed(`This workflow requires a GitHub-hosted Linux runner, got: environment=${runnerEnvironment || 'unknown'}, os=${runnerOS || 'unknown'}`);
}
-
name: Install dependencies
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_RUNTIME-MODULE: ${{ env.RUNTIME_MODULE }}
INPUT_RUNTIME-INSTALL-ARGS: ${{ env.RUNTIME_INSTALL_ARGS }}
with:
script: |
const npmArgs = ['install', ...core.getMultilineInput('runtime-install-args'), core.getInput('runtime-module')];
const maxAttempts = 3;
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
const exitCode = await exec.exec('npm', npmArgs, {ignoreReturnCode: true});
if (exitCode === 0) {
return;
}
if (attempt === maxAttempts) {
core.setFailed(`npm install failed after ${maxAttempts} attempts`);
return;
}
const retryDelayMs = attempt * 50;
core.info(`npm install failed with exit code ${exitCode}; retrying in ${retryDelayMs}ms`);
await new Promise(resolve => setTimeout(resolve, retryDelayMs));
}
-
name: Docker meta
id: meta
if: ${{ inputs.output == 'image' }}
uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302 # v6.2.0
with:
images: ${{ needs.prepare.outputs.metaImages }}
tags: ${{ inputs.meta-tags }}
flavor: ${{ inputs.meta-flavor }}
labels: ${{ inputs.meta-labels }}
annotations: ${{ inputs.meta-annotations }}
bake-target: ${{ inputs.meta-bake-target }}
-
name: Set up QEMU
uses: docker/setup-qemu-action@99012661954931238ded8c8b007157a8430204e1 # v4.4.0
if: ${{ inputs.setup-qemu }}
with:
image: ${{ env.BINFMT_IMAGE }}
cache-image: false
-
name: Set GitHub runtime outputs
id: github-runtime
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
with:
script: |
const idTokenRequestToken = process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN || '';
const idTokenRequestUrl = process.env.ACTIONS_ID_TOKEN_REQUEST_URL || '';
if (idTokenRequestToken) {
core.setSecret(idTokenRequestToken);
}
if (idTokenRequestUrl) {
core.setSecret(idTokenRequestUrl);
}
core.setOutput('actions-id-token-request-token', idTokenRequestToken);
core.setOutput('actions-id-token-request-url', idTokenRequestUrl);
-
name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
with:
version: ${{ env.BUILDX_VERSION }}
cache-binary: false
buildkitd-flags: --debug
driver-opts: |
image=${{ env.BUILDKIT_IMAGE }}
env.ACTIONS_ID_TOKEN_REQUEST_TOKEN=${{ steps.github-runtime.outputs.actions-id-token-request-token }}
env.ACTIONS_ID_TOKEN_REQUEST_URL=${{ steps.github-runtime.outputs.actions-id-token-request-url }}
buildkitd-config-inline: |
proxyNetwork = ${{ needs.prepare.outputs.proxyNetwork }}
[cache]
[cache.gha]
[cache.gha.sign]
command = [${{ needs.prepare.outputs.ghaCacheSign == 'true' && '"ghacache-sign-script.sh"' || '' }}]
[cache.gha.verify]
required = ${{ needs.prepare.outputs.ghaCacheSign }}
[cache.gha.verify.policy]
timestampThreshold = 1
tlogThreshold = ${{ needs.prepare.outputs.privateRepo == 'true' && '0' || '1' }}
subjectAlternativeName = "https://github.com/docker/github-builder/.github/workflows/bake.yml*"
githubWorkflowRepository = "${{ github.repository }}"
issuer = "https://token.actions.githubusercontent.com"
runnerEnvironment = "github-hosted"
sourceRepositoryURI = "${{ github.server_url }}/${{ github.repository }}"
-
name: Install Cosign
if: ${{ needs.prepare.outputs.sign == 'true' || inputs.cache }}
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_COSIGN-VERSION: ${{ env.COSIGN_VERSION }}
INPUT_BUILDER-NAME: ${{ steps.buildx.outputs.name }}
INPUT_GHA-CACHE-SIGN-SCRIPT: |
#!/bin/sh
set -e
# Create temporary files
tmp_dir=$(mktemp -d)
out_file="$tmp_dir/bundle"
in_file="$tmp_dir/blob"
signing_config="$tmp_dir/signing-config.json"
trap 'rm -rf "$tmp_dir"' EXIT
cat > "$in_file"
no_default_rekor=
if [ "${{ needs.prepare.outputs.privateRepo }}" = "true" ]; then
no_default_rekor="--no-default-rekor=true"
fi
set -x
# Create signing config
COSIGN_EXPERIMENTAL=1 cosign signing-config create \
--with-default-services=true \
${no_default_rekor:+$no_default_rekor} \
--out="$signing_config"
# Sign with cosign
cosign sign-blob \
--yes \
--oidc-provider github-actions \
--new-bundle-format \
--signing-config "$signing_config" \
--bundle "$out_file" \
"$in_file"
# Output bundle to stdout
cat "$out_file"
with:
script: |
const fs = require('fs');
const os = require('os');
const path = require('path');
const { Buildx } = require('@docker/github-builder-runtime/lib/buildx/buildx');
const { Cosign } = require('@docker/github-builder-runtime/lib/cosign/cosign');
const { Install } = require('@docker/github-builder-runtime/lib/cosign/install');
const inpCosignVersion = core.getInput('cosign-version');
const inpBuilderName = core.getInput('builder-name');
const inpGHACacheSignScript = core.getInput('gha-cache-sign-script');
const cosignInstall = new Install();
const cosignBinPath = await cosignInstall.download({
version: core.getInput('cosign-version'),
ghaNoCache: true,
skipState: true,
verifySignature: true
});
const cosignPath = await cosignInstall.install(cosignBinPath);
const cosign = new Cosign();
await cosign.printVersion();
const containerName = `${Buildx.containerNamePrefix}${inpBuilderName}0`;
const ghaCacheSignScriptPath = path.join(os.tmpdir(), `ghacache-sign-script.sh`);
core.info(`Writing GitHub Actions cache sign script to ${ghaCacheSignScriptPath}`);
await fs.writeFileSync(ghaCacheSignScriptPath, inpGHACacheSignScript, {mode: 0o700});
core.info(`Copying GitHub Actions cache sign script to BuildKit container ${containerName}`);
await exec.exec('docker', [
'cp',
ghaCacheSignScriptPath,
`${containerName}:/usr/bin/ghacache-sign-script.sh`
]);
core.info(`Copying cosign binary to BuildKit container ${containerName}`);
await exec.exec('docker', [
'cp',
cosignPath,
`${containerName}:/usr/bin/cosign`
]);
-
name: Configure AWS credentials
if: ${{ needs.registry-identities.outputs.aws-ecr-enabled == 'true' }}
uses: aws-actions/configure-aws-credentials@e1253824e5c10ff9df46874f81ed3ec929e19cfd # v6.3.0
with:
role-to-assume: ${{ needs.registry-identities.outputs.aws-ecr-role-to-assume }}
aws-region: ${{ needs.registry-identities.outputs.aws-ecr-region }}
-
name: Login to Amazon ECR
if: ${{ needs.registry-identities.outputs.aws-ecr-enabled == 'true' }}
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
env:
AWS_ACCOUNT_IDS: ${{ needs.registry-identities.outputs.aws-ecr-account-ids }}
with:
registry-auth: |
- registry: ${{ needs.registry-identities.outputs.aws-ecr-registry }}
-
name: Authenticate to Google Cloud
id: gcp-wif-auth
if: ${{ needs.registry-identities.outputs.gcp-wif-enabled == 'true' }}
uses: google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093 # v3.0.0
with:
token_format: access_token
workload_identity_provider: ${{ needs.registry-identities.outputs.gcp-wif-workload-identity-provider }}
service_account: ${{ needs.registry-identities.outputs.gcp-wif-service-account }}
project_id: ${{ needs.registry-identities.outputs.gcp-wif-project-id }}
create_credentials_file: false
export_environment_variables: false
-
name: Login to Google Artifact Registry
if: ${{ needs.registry-identities.outputs.gcp-wif-enabled == 'true' }}
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
with:
registry-auth: |
- registry: ${{ needs.registry-identities.outputs.gcp-wif-registry }}
username: oauth2accesstoken
password: ${{ steps.gcp-wif-auth.outputs.access_token }}
-
name: Login to Docker Hub with OIDC
if: ${{ needs.registry-identities.outputs.dockerhub-oidc-enabled == 'true' }}
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
env:
DOCKERHUB_OIDC_CONNECTIONID: ${{ needs.registry-identities.outputs.dockerhub-oidc-connection-id }}
with:
registry-auth: |
- registry: ${{ needs.registry-identities.outputs.dockerhub-oidc-registry }}
username: ${{ needs.registry-identities.outputs.dockerhub-oidc-username }}
scope: ${{ needs.registry-identities.outputs.dockerhub-oidc-scope }}
-
name: Authenticate to Azure
if: ${{ needs.registry-identities.outputs.azure-acr-enabled == 'true' }}
uses: azure/login@a641126d1b8aa4d1fa005f4f92df94a3a4c4c906 # v3.1.0
with:
client-id: ${{ needs.registry-identities.outputs.azure-acr-client-id }}
tenant-id: ${{ needs.registry-identities.outputs.azure-acr-tenant-id }}
subscription-id: ${{ needs.registry-identities.outputs.azure-acr-subscription-id }}
-
name: Login to Azure Container Registry
if: ${{ needs.registry-identities.outputs.azure-acr-enabled == 'true' }}
env:
ACR_REGISTRY: ${{ needs.registry-identities.outputs.azure-acr-registry }}
AZURE_CORE_OUTPUT: none
run: az acr login --name "${ACR_REGISTRY%.azurecr.io}"
-
name: Set up chainctl
if: ${{ needs.registry-identities.outputs.chainguard-enabled == 'true' }}
uses: chainguard-dev/setup-chainctl@2cddd35a2f120d9973e58094dc6878c93cf58c28 # v0.5.1
with:
identity: ${{ needs.registry-identities.outputs.chainguard-identity }}
apk-host: ${{ needs.registry-identities.outputs.chainguard-apk-host }}
libraries-host: ${{ needs.registry-identities.outputs.chainguard-libraries-host }}
-
name: Login to registry
if: ${{ needs.prepare.outputs.registryLogin == 'true' && env.REGISTRY_AUTHS_PRESENT == 'true' }}
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
with:
registry-auth: ${{ secrets.registry-auths }}
-
name: Prepare
id: prepare
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_PLATFORM: ${{ matrix.platform }}
INPUT_SBOM-IMAGE: ${{ env.SBOM_IMAGE }}
INPUT_LOCAL-EXPORT-DIR: ${{ env.LOCAL_EXPORT_DIR }}
INPUT_CACHE: ${{ inputs.cache }}
INPUT_CACHE-SCOPE: ${{ inputs.cache-scope }}
INPUT_CACHE-MODE: ${{ inputs.cache-mode }}
INPUT_BUILD-SECRETS: ${{ secrets.build-secrets }}
INPUT_TARGETS: ${{ needs.prepare.outputs.targets }}
INPUT_CONTEXT: ${{ inputs.context }}
INPUT_FILES: ${{ inputs.files }}
INPUT_OUTPUT: ${{ inputs.output }}
INPUT_PUSH: ${{ inputs.push }}
INPUT_SBOM: ${{ inputs.sbom }}
INPUT_SET: ${{ inputs.set }}
INPUT_TARGET: ${{ inputs.target }}
INPUT_VARS: ${{ inputs.vars }}
INPUT_META-IMAGES: ${{ needs.prepare.outputs.metaImages }}
INPUT_META-VERSION: ${{ steps.meta.outputs.version }}
INPUT_META-TAGS: ${{ steps.meta.outputs.tags }}
INPUT_SET-META-ANNOTATIONS: ${{ inputs.set-meta-annotations }}
INPUT_SET-META-LABELS: ${{ inputs.set-meta-labels }}
INPUT_BAKE-FILE-TAGS: ${{ steps.meta.outputs.bake-file-tags }}
INPUT_BAKE-FILE-ANNOTATIONS: ${{ steps.meta.outputs.bake-file-annotations }}
INPUT_BAKE-FILE-LABELS: ${{ steps.meta.outputs.bake-file-labels }}
INPUT_BUILDKIT-PROXY-NETWORK: ${{ inputs.buildkit-proxy-network }}
with:
script: |
const os = require('os');
const { Build } = require('@docker/github-builder-runtime/lib/buildx/build');
const { BuildSecrets } = require('@docker/github-builder-runtime/lib/github-builder/build-secrets');
const { GitHub } = require('@docker/github-builder-runtime/lib/github/github');
const { Util } = require('@docker/github-builder-runtime/lib/util');
const inpPlatform = core.getInput('platform');
const platformPairSuffix = inpPlatform ? `-${inpPlatform.replace(/\//g, '-')}` : '';
core.setOutput('platform-pair-suffix', platformPairSuffix);
const inpSbomImage = core.getInput('sbom-image');
const inpLocalExportDir = core.getInput('local-export-dir');
const inpCache = core.getBooleanInput('cache');
const inpCacheScope = core.getInput('cache-scope');
const inpCacheMode = core.getInput('cache-mode');
const inpBuildSecrets = core.getInput('build-secrets', {trimWhitespace: false});
const inpTargets = core.getInput('targets');
const inpContext = core.getInput('context');
const inpFiles = Util.getInputList('files');
const inpOutput = core.getInput('output');
const inpPush = core.getBooleanInput('push');
const inpSbom = core.getBooleanInput('sbom');
const inpSet = Util.getInputList('set', {ignoreComma: true, quote: false});
const inpTarget = core.getInput('target');
const inpVars = Util.getInputList('vars');
const inpBuildkitProxyNetwork = core.getBooleanInput('buildkit-proxy-network');
const inpMetaImages = core.getMultilineInput('meta-images');
const inpMetaVersion = core.getInput('meta-version');
const inpMetaTags = core.getMultilineInput('meta-tags');
const inpSetMetaAnnotations = core.getBooleanInput('set-meta-annotations');
const inpSetMetaLabels = core.getBooleanInput('set-meta-labels');
const inpBakeFileTags = core.getInput('bake-file-tags');
const inpBakeFileAnnotations = core.getInput('bake-file-annotations');
const inpBakeFileLabels = core.getInput('bake-file-labels');
const meta = {
version: inpMetaVersion,
tags: inpMetaTags
};
const renderTemplate = value => Util.compileHandlebars(value, {noEscape: true}, {meta});
const gitContextAttrs = GitHub.context.ref.startsWith('refs/tags/') ? {checksum: GitHub.context.sha} : {'fetch-by-commit': 'true'};
const bakeSource = await new Build().gitContext({subdir: inpContext, attrs: gitContextAttrs});
await core.group(`Set source output`, async () => {
core.info(bakeSource);
core.setOutput('source', bakeSource);
});
await core.group(`Set target output`, async () => {
core.info(inpTarget);
core.setOutput('target', inpTarget);
});
const sbom = inpSbom ? `generator=${inpSbomImage}` : 'false';
await core.group(`Set sbom`, async () => {
core.info(sbom);
core.setOutput('sbom', sbom);
});
let buildSecrets;
try {
buildSecrets = BuildSecrets.prepareBake(inpBuildSecrets, inpTarget, JSON.parse(inpTargets || '[]'));
} catch (err) {
core.setFailed(err.message);
return;
}
core.setOutput('secret-dir', buildSecrets.directory);
const envs = Object.assign({},
inpVars ? inpVars.reduce((acc, curr) => {
const idx = curr.indexOf('=');
if (idx !== -1) {
acc[curr.substring(0, idx)] = curr.substring(idx + 1);
}
return acc;
}, {}) : {},
{
BUILDKIT_MULTI_PLATFORM: '1'
}
);
// Git authentication is supplied directly to the Bake action.
delete envs.BUILDX_BAKE_GIT_AUTH_TOKEN;
await core.group(`Set envs`, async () => {
core.info(JSON.stringify(Object.keys(envs).sort(), null, 2));
core.setOutput('envs', JSON.stringify(envs));
});
let bakeFiles = inpFiles;
await core.group(`Set bake files`, async () => {
if (bakeFiles.length === 0) {
bakeFiles = ['docker-bake.hcl'];
}
if (inpBakeFileTags) {
bakeFiles.push(`cwd://${inpBakeFileTags}`);
}
if (inpSetMetaAnnotations && inpBakeFileAnnotations) {
bakeFiles.push(`cwd://${inpBakeFileAnnotations}`);
}
if (inpSetMetaLabels && inpBakeFileLabels) {
bakeFiles.push(`cwd://${inpBakeFileLabels}`);
}
core.info(JSON.stringify(bakeFiles, null, 2));
core.setOutput('files', bakeFiles.join(os.EOL));
});
let outputOverride = '';
switch (inpOutput) {
case 'image':
if (inpMetaImages.length == 0) {
core.setFailed('meta-images is required when output is image');
return;
}
outputOverride = `*.output=type=image,"name=${inpMetaImages.join(',')}",oci-artifact=true,push-by-digest=true,name-canonical=true,push=${inpPush}`;
break;
case 'local':
outputOverride = `*.output=type=local,platform-split=true,dest=${inpLocalExportDir}`;
break;
default:
core.setFailed(`Invalid output: ${inpOutput}`);
return;
}
let bakeOverrides = [];
try {
bakeOverrides = inpSet.map(override => renderTemplate(override));
} catch (err) {
core.setFailed(`Failed to render Handlebars template: ${err.message}`);
return;
}
await core.group(`Set bake overrides`, async () => {
bakeOverrides.push(outputOverride);
bakeOverrides.push('*.tags=');
if (GitHub.context.payload.repository?.private ?? false) {
// if this is a private repository, we set min provenance mode
bakeOverrides.push(`*.attest=type=provenance,${Build.resolveProvenanceAttrs('mode=min,version=v1')}`);
} else {
// for a public repository, we set max provenance mode
bakeOverrides.push(`*.attest=type=provenance,${Build.resolveProvenanceAttrs('mode=max,version=v1')}`);
}
if (inpPlatform) {
bakeOverrides.push(`*.platform=${inpPlatform}`);
}
if (inpCache) {
const proxyNetworkSuffix = inpBuildkitProxyNetwork ? '-proxy-network' : '';
bakeOverrides.push(`*.cache-from=type=gha,scope=${inpCacheScope || inpTarget}${platformPairSuffix}${proxyNetworkSuffix}`);
bakeOverrides.push(`*.cache-to=type=gha,ignore-error=true,scope=${inpCacheScope || inpTarget}${platformPairSuffix}${proxyNetworkSuffix},mode=${inpCacheMode}`);