Skip to content

Commit db1823b

Browse files
committed
build/bake: compression inputs for image output
Signed-off-by: Devin Buhl <devin@buhl.casa>
1 parent b28acda commit db1823b

7 files changed

Lines changed: 240 additions & 5 deletions

File tree

‎.github/workflows/.test-bake.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -739,3 +739,64 @@ jobs:
739739
username: ${{ vars.DOCKERHUB_OIDC_USERNAME }}
740740
connection_id: ${{ vars.DOCKERHUB_OIDC_CONNECTIONID }}
741741
scope: 'dhi.io@pull'
742+
743+
bake-ghcr-compression:
744+
uses: ./.github/workflows/bake.yml
745+
permissions:
746+
contents: read
747+
id-token: write
748+
packages: write
749+
with:
750+
compression: zstd
751+
compression-level: 9
752+
force-compression: true
753+
context: test
754+
output: image
755+
push: ${{ github.event_name != 'pull_request' }}
756+
target: compression
757+
meta-images: ghcr.io/docker/github-builder-test
758+
meta-tags: |
759+
type=raw,value=bake-compression-${{ github.run_id }}
760+
secrets:
761+
registry-auths: |
762+
- registry: ghcr.io
763+
username: ${{ github.actor }}
764+
password: ${{ secrets.GITHUB_TOKEN }}
765+
766+
bake-ghcr-compression-check:
767+
runs-on: ubuntu-26.04
768+
if: ${{ github.event_name != 'pull_request' }}
769+
needs:
770+
- bake-ghcr-compression
771+
steps:
772+
-
773+
name: Check layers compression
774+
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
775+
env:
776+
INPUT_IMAGE: ghcr.io/docker/github-builder-test
777+
INPUT_TAG: bake-compression-${{ github.run_id }}
778+
with:
779+
script: |
780+
const inpImage = core.getInput('image');
781+
const inpTag = core.getInput('tag');
782+
783+
const inspectRaw = async ref => {
784+
const res = await exec.getExecOutput('docker', ['buildx', 'imagetools', 'inspect', '--raw', ref], {silent: true});
785+
return JSON.parse(res.stdout);
786+
};
787+
788+
const index = await inspectRaw(`${inpImage}:${inpTag}`);
789+
const digests = index.manifests.filter(m => m.platform?.os !== 'unknown').map(m => m.digest);
790+
if (digests.length === 0) {
791+
core.setFailed(`No platform manifests found for ${inpImage}:${inpTag}`);
792+
return;
793+
}
794+
for (const digest of digests) {
795+
const manifest = await inspectRaw(`${inpImage}@${digest}`);
796+
const mediaTypes = manifest.layers.map(layer => layer.mediaType);
797+
core.info(`${digest}: ${JSON.stringify(mediaTypes)}`);
798+
if (mediaTypes.length === 0 || !mediaTypes.every(mediaType => mediaType.endsWith('+zstd'))) {
799+
core.setFailed(`Layers of ${inpImage}@${digest} are not zstd compressed`);
800+
return;
801+
}
802+
}

‎.github/workflows/.test-build.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -748,3 +748,64 @@ jobs:
748748
username: ${{ vars.DOCKERHUB_OIDC_USERNAME }}
749749
connection_id: ${{ vars.DOCKERHUB_OIDC_CONNECTIONID }}
750750
scope: 'dhi.io@pull'
751+
752+
build-ghcr-compression:
753+
uses: ./.github/workflows/build.yml
754+
permissions:
755+
contents: read
756+
id-token: write
757+
packages: write
758+
with:
759+
compression: zstd
760+
compression-level: 9
761+
force-compression: true
762+
file: test/compression.Dockerfile
763+
output: image
764+
platforms: linux/amd64,linux/arm64
765+
push: ${{ github.event_name != 'pull_request' }}
766+
meta-images: ghcr.io/docker/github-builder-test
767+
meta-tags: |
768+
type=raw,value=build-compression-${{ github.run_id }}
769+
secrets:
770+
registry-auths: |
771+
- registry: ghcr.io
772+
username: ${{ github.actor }}
773+
password: ${{ secrets.GITHUB_TOKEN }}
774+
775+
build-ghcr-compression-check:
776+
runs-on: ubuntu-26.04
777+
if: ${{ github.event_name != 'pull_request' }}
778+
needs:
779+
- build-ghcr-compression
780+
steps:
781+
-
782+
name: Check layers compression
783+
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
784+
env:
785+
INPUT_IMAGE: ghcr.io/docker/github-builder-test
786+
INPUT_TAG: build-compression-${{ github.run_id }}
787+
with:
788+
script: |
789+
const inpImage = core.getInput('image');
790+
const inpTag = core.getInput('tag');
791+
792+
const inspectRaw = async ref => {
793+
const res = await exec.getExecOutput('docker', ['buildx', 'imagetools', 'inspect', '--raw', ref], {silent: true});
794+
return JSON.parse(res.stdout);
795+
};
796+
797+
const index = await inspectRaw(`${inpImage}:${inpTag}`);
798+
const digests = index.manifests.filter(m => m.platform?.os !== 'unknown').map(m => m.digest);
799+
if (digests.length === 0) {
800+
core.setFailed(`No platform manifests found for ${inpImage}:${inpTag}`);
801+
return;
802+
}
803+
for (const digest of digests) {
804+
const manifest = await inspectRaw(`${inpImage}@${digest}`);
805+
const mediaTypes = manifest.layers.map(layer => layer.mediaType);
806+
core.info(`${digest}: ${JSON.stringify(mediaTypes)}`);
807+
if (mediaTypes.length === 0 || !mediaTypes.every(mediaType => mediaType.endsWith('+zstd'))) {
808+
core.setFailed(`Layers of ${inpImage}@${digest} are not zstd compressed`);
809+
return;
810+
}
811+
}

‎.github/workflows/bake.yml‎

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,19 @@ on:
5959
description: "Cache layers to export if cache enabled (min or max)"
6060
required: false
6161
default: 'min'
62+
compression:
63+
type: string
64+
description: "Compression algorithm for image layers (one of uncompressed, gzip, estargz or zstd) (for image output)"
65+
required: false
66+
compression-level:
67+
type: string
68+
description: "Compression level for image layers (0-9 for gzip and estargz, 0-22 for zstd) (for image output)"
69+
required: false
70+
force-compression:
71+
type: boolean
72+
description: "Force re-compressing layers imported from a previous image if their compression type differs (for image output)"
73+
required: false
74+
default: false
6275
context:
6376
type: string
6477
description: "Context to build from in the Git working tree"
@@ -227,6 +240,7 @@ jobs:
227240
ghaCacheSign: ${{ steps.set.outputs.ghaCacheSign }}
228241
proxyNetwork: ${{ steps.set.outputs.proxyNetwork }}
229242
registryLogin: ${{ steps.set.outputs.registryLogin }}
243+
compressionAttrs: ${{ steps.set.outputs.compressionAttrs }}
230244
steps:
231245
-
232246
name: Install dependencies
@@ -332,6 +346,9 @@ jobs:
332346
INPUT_SIGN: ${{ inputs.sign }}
333347
INPUT_TARGET: ${{ inputs.target }}
334348
INPUT_VARS: ${{ inputs.vars }}
349+
INPUT_COMPRESSION: ${{ inputs.compression }}
350+
INPUT_COMPRESSION-LEVEL: ${{ inputs.compression-level }}
351+
INPUT_FORCE-COMPRESSION: ${{ inputs.force-compression }}
335352
INPUT_GITHUB-TOKEN: ${{ secrets.github-token || github.token }}
336353
INPUT_BUILDKIT-PROXY-NETWORK: ${{ inputs.buildkit-proxy-network }}
337354
with:
@@ -365,8 +382,11 @@ jobs:
365382
const inpSign = core.getInput('sign');
366383
const inpTarget = core.getInput('target');
367384
const inpGitHubToken = core.getInput('github-token');
385+
const inpCompression = core.getInput('compression');
386+
const inpCompressionLevel = core.getInput('compression-level');
387+
const inpForceCompression = core.getBooleanInput('force-compression');
368388
const inpProxyNetwork = core.getBooleanInput('buildkit-proxy-network');
369-
389+
370390
let runnerConfig;
371391
try {
372392
runnerConfig = RunnerMapping.parse(inpRunner);
@@ -405,6 +425,28 @@ jobs:
405425
}
406426
const registryLogin = inpRegistryLogin === 'auto' ? inpOutput === 'image' && inpPush : inpRegistryLogin === 'true';
407427
428+
if (inpCompression && !['uncompressed', 'gzip', 'estargz', 'zstd'].includes(inpCompression)) {
429+
core.setFailed(`Invalid compression input: ${inpCompression}`);
430+
return;
431+
}
432+
if (inpCompressionLevel && !/^\d+$/.test(inpCompressionLevel)) {
433+
core.setFailed(`Invalid compression-level input: ${inpCompressionLevel}`);
434+
return;
435+
}
436+
const compressionAttrs = [];
437+
if (inpCompression) {
438+
compressionAttrs.push(`compression=${inpCompression}`);
439+
}
440+
if (inpCompressionLevel) {
441+
compressionAttrs.push(`compression-level=${inpCompressionLevel}`);
442+
}
443+
if (inpForceCompression) {
444+
compressionAttrs.push('force-compression=true');
445+
}
446+
if (inpOutput === 'local' && compressionAttrs.length > 0) {
447+
core.warning(`compression inputs are ignored when output is local`);
448+
}
449+
408450
const bakeVars = BakeVars.resolve(inpVars);
409451
await core.group(`Set bake vars`, async () => {
410452
core.info(JSON.stringify(bakeVars.map(value => {
@@ -512,6 +554,10 @@ jobs:
512554
core.info(`registryLogin: ${registryLogin}`);
513555
core.setOutput('registryLogin', registryLogin);
514556
});
557+
await core.group(`Set compressionAttrs output`, async () => {
558+
core.info(`compressionAttrs: ${compressionAttrs.join(',')}`);
559+
core.setOutput('compressionAttrs', compressionAttrs.join(','));
560+
});
515561
516562
build:
517563
runs-on: ${{ matrix.runner }}
@@ -835,6 +881,7 @@ jobs:
835881
INPUT_SET: ${{ inputs.set }}
836882
INPUT_TARGET: ${{ inputs.target }}
837883
INPUT_VARS: ${{ inputs.vars }}
884+
INPUT_COMPRESSION-ATTRS: ${{ needs.prepare.outputs.compressionAttrs }}
838885
INPUT_META-IMAGES: ${{ needs.prepare.outputs.metaImages }}
839886
INPUT_META-VERSION: ${{ steps.meta.outputs.version }}
840887
INPUT_META-TAGS: ${{ steps.meta.outputs.tags }}
@@ -874,6 +921,7 @@ jobs:
874921
const inpTarget = core.getInput('target');
875922
const inpVars = Util.getInputList('vars', {ignoreComma: true, quote: false});
876923
const inpBuildkitProxyNetwork = core.getBooleanInput('buildkit-proxy-network');
924+
const inpCompressionAttrs = core.getInput('compression-attrs');
877925
878926
const inpMetaImages = core.getMultilineInput('meta-images');
879927
const inpMetaVersion = core.getInput('meta-version');
@@ -951,7 +999,7 @@ jobs:
951999
core.setFailed('meta-images is required when output is image');
9521000
return;
9531001
}
954-
outputOverride = `*.output=type=image,"name=${inpMetaImages.join(',')}",oci-artifact=true,push-by-digest=true,name-canonical=true,push=${inpPush}`;
1002+
outputOverride = `*.output=type=image,"name=${inpMetaImages.join(',')}",oci-artifact=true,push-by-digest=true,name-canonical=true,push=${inpPush}${inpCompressionAttrs ? `,${inpCompressionAttrs}` : ''}`;
9551003
break;
9561004
case 'local':
9571005
outputOverride = `*.output=type=local,platform-split=true,dest=${inpLocalExportDir}`;

‎.github/workflows/build.yml‎

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,19 @@ on:
6767
description: "Cache layers to export if cache enabled (min or max)"
6868
required: false
6969
default: 'min'
70+
compression:
71+
type: string
72+
description: "Compression algorithm for image layers (one of uncompressed, gzip, estargz or zstd) (for image output)"
73+
required: false
74+
compression-level:
75+
type: string
76+
description: "Compression level for image layers (0-9 for gzip and estargz, 0-22 for zstd) (for image output)"
77+
required: false
78+
force-compression:
79+
type: boolean
80+
description: "Force re-compressing layers imported from a previous image if their compression type differs (for image output)"
81+
required: false
82+
default: false
7083
context:
7184
type: string
7285
description: "Context to build from in the Git working tree"
@@ -237,6 +250,7 @@ jobs:
237250
ghaCacheSign: ${{ steps.set.outputs.ghaCacheSign }}
238251
proxyNetwork: ${{ steps.set.outputs.proxyNetwork }}
239252
registryLogin: ${{ steps.set.outputs.registryLogin }}
253+
compressionAttrs: ${{ steps.set.outputs.compressionAttrs }}
240254
steps:
241255
-
242256
name: Install dependencies
@@ -328,6 +342,9 @@ jobs:
328342
INPUT_PUSH: ${{ inputs.push }}
329343
INPUT_REGISTRY-LOGIN: ${{ inputs.registry-login }}
330344
INPUT_SIGN: ${{ inputs.sign }}
345+
INPUT_COMPRESSION: ${{ inputs.compression }}
346+
INPUT_COMPRESSION-LEVEL: ${{ inputs.compression-level }}
347+
INPUT_FORCE-COMPRESSION: ${{ inputs.force-compression }}
331348
INPUT_BUILDKIT-PROXY-NETWORK: ${{ inputs.buildkit-proxy-network }}
332349
with:
333350
script: |
@@ -348,8 +365,11 @@ jobs:
348365
const inpPush = core.getBooleanInput('push');
349366
const inpRegistryLogin = core.getInput('registry-login');
350367
const inpSign = core.getInput('sign');
368+
const inpCompression = core.getInput('compression');
369+
const inpCompressionLevel = core.getInput('compression-level');
370+
const inpForceCompression = core.getBooleanInput('force-compression');
351371
const inpProxyNetwork = core.getBooleanInput('buildkit-proxy-network');
352-
372+
353373
let runnerConfig;
354374
try {
355375
runnerConfig = RunnerMapping.parse(inpRunner);
@@ -382,6 +402,28 @@ jobs:
382402
}
383403
const registryLogin = inpRegistryLogin === 'auto' ? inpOutput === 'image' && inpPush : inpRegistryLogin === 'true';
384404
405+
if (inpCompression && !['uncompressed', 'gzip', 'estargz', 'zstd'].includes(inpCompression)) {
406+
core.setFailed(`Invalid compression input: ${inpCompression}`);
407+
return;
408+
}
409+
if (inpCompressionLevel && !/^\d+$/.test(inpCompressionLevel)) {
410+
core.setFailed(`Invalid compression-level input: ${inpCompressionLevel}`);
411+
return;
412+
}
413+
const compressionAttrs = [];
414+
if (inpCompression) {
415+
compressionAttrs.push(`compression=${inpCompression}`);
416+
}
417+
if (inpCompressionLevel) {
418+
compressionAttrs.push(`compression-level=${inpCompressionLevel}`);
419+
}
420+
if (inpForceCompression) {
421+
compressionAttrs.push('force-compression=true');
422+
}
423+
if (inpOutput === 'local' && compressionAttrs.length > 0) {
424+
core.warning(`compression inputs are ignored when output is local`);
425+
}
426+
385427
if (inpDistribute && inpPlatforms.length > inpMatrixSizeLimit) {
386428
core.setFailed(`Platforms to build exceed matrix size limit of ${inpMatrixSizeLimit}`);
387429
return;
@@ -443,6 +485,10 @@ jobs:
443485
core.info(`registryLogin: ${registryLogin}`);
444486
core.setOutput('registryLogin', registryLogin);
445487
});
488+
await core.group(`Set compressionAttrs output`, async () => {
489+
core.info(`compressionAttrs: ${compressionAttrs.join(',')}`);
490+
core.setOutput('compressionAttrs', compressionAttrs.join(','));
491+
});
446492
447493
build:
448494
runs-on: ${{ matrix.runner }}
@@ -767,6 +813,7 @@ jobs:
767813
INPUT_PUSH: ${{ inputs.push }}
768814
INPUT_SBOM: ${{ inputs.sbom }}
769815
INPUT_TARGET: ${{ inputs.target }}
816+
INPUT_COMPRESSION-ATTRS: ${{ needs.prepare.outputs.compressionAttrs }}
770817
INPUT_META-IMAGES: ${{ needs.prepare.outputs.metaImages }}
771818
INPUT_META-VERSION: ${{ steps.meta.outputs.version }}
772819
INPUT_META-TAGS: ${{ steps.meta.outputs.tags }}
@@ -803,7 +850,8 @@ jobs:
803850
const inpSbom = core.getBooleanInput('sbom');
804851
const inpTarget = core.getInput('target');
805852
const inpBuildkitProxyNetwork = core.getBooleanInput('buildkit-proxy-network');
806-
853+
const inpCompressionAttrs = core.getInput('compression-attrs');
854+
807855
const inpMetaImages = core.getMultilineInput('meta-images');
808856
const inpMetaVersion = core.getInput('meta-version');
809857
const inpMetaTags = core.getMultilineInput('meta-tags');
@@ -828,7 +876,7 @@ jobs:
828876
core.setFailed('meta-images is required when output is image');
829877
return;
830878
}
831-
core.setOutput('output', `type=image,"name=${inpMetaImages.join(',')}",oci-artifact=true,push-by-digest=true,name-canonical=true,push=${inpPush}`);
879+
core.setOutput('output', `type=image,"name=${inpMetaImages.join(',')}",oci-artifact=true,push-by-digest=true,name-canonical=true,push=${inpPush}${inpCompressionAttrs ? `,${inpCompressionAttrs}` : ''}`);
832880
break;
833881
case 'local':
834882
core.setOutput('output', `type=local,platform-split=true,dest=${inpLocalExportDir}`);

0 commit comments

Comments
 (0)