Skip to content

set index annotations on imagetools create #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
crazy-max wants to merge 1 commit into
base: main
Choose a base branch
from
+104 −0
Draft

set index annotations on imagetools create #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/.test-bake.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,3 +596,29 @@ jobs:
sbom: true
sign: ${{ github.event_name != 'pull_request' }}
target: go-cross-with-contexts

bake-ghcr-index-annotations:
uses: ./.github/workflows/bake.yml
permissions:
contents: read
id-token: write
packages: write
with:
context: test
output: image
push: ${{ github.event_name != 'pull_request' }}
sbom: true
set: |
*.args.VERSION={{meta.version}}
target: hello-cross
set-meta-annotations: true
meta-images: ghcr.io/docker/github-builder-test
meta-tags: |
type=raw,value=bake-index-annotations-${{ github.run_id }}
meta-annotations: |
io.github.docker.github-builder.test-index-annotation=bake-${{ github.run_id }}
secrets:
registry-auths: |
- registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
26 changes: 26 additions & 0 deletions .github/workflows/.test-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,3 +615,29 @@ jobs:
- registry: registry-1-stage.docker.io
username: ${{ vars.DOCKERHUB_STAGE_USERNAME }}
password: ${{ secrets.DOCKERHUB_STAGE_TOKEN }}

build-ghcr-index-annotations:
uses: ./.github/workflows/build.yml
permissions:
contents: read
id-token: write
packages: write
with:
annotations: |
io.github.docker.github-builder.test-index-annotation=build-${{ github.run_id }}
build-args: |
VERSION={{meta.version}}
file: test/hello.Dockerfile
output: image
platforms: linux/amd64,linux/arm64
push: ${{ github.event_name != 'pull_request' }}
sbom: true
set-meta-annotations: true
meta-images: ghcr.io/docker/github-builder-test
meta-tags: |
type=raw,value=build-index-annotations-${{ github.run_id }}
secrets:
registry-auths: |
- registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
25 changes: 25 additions & 0 deletions .github/workflows/bake.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,6 +976,8 @@ jobs:
INPUT_IMAGE-NAMES: ${{ inputs.meta-images }}
INPUT_TAG-NAMES: ${{ steps.meta.outputs.tag-names }}
INPUT_BUILD-OUTPUTS: ${{ toJSON(needs.build.outputs) }}
INPUT_SET-META-ANNOTATIONS: ${{ inputs.set-meta-annotations }}
INPUT_META-ANNOTATIONS: ${{ steps.meta.outputs.annotations }}
with:
script: |
const { ImageTools } = require('@docker/actions-toolkit/lib/buildx/imagetools');
Expand All @@ -984,6 +986,28 @@ jobs:
const inpImageNames = core.getMultilineInput('image-names');
const inpTagNames = core.getMultilineInput('tag-names');
const inpBuildOutputs = JSON.parse(core.getInput('build-outputs'));
const inpSetMetaAnnotations = core.getBooleanInput('set-meta-annotations');
const inpMetaAnnotations = core.getMultilineInput('meta-annotations');

const toIndexAnnotation = annotation => {
const keyEnd = annotation.indexOf('=');
const rawKey = keyEnd === -1 ? annotation : annotation.substring(0, keyEnd);
const rawValue = keyEnd === -1 ? '' : annotation.substring(keyEnd);
const typeSeparator = rawKey.indexOf(':');
if (typeSeparator !== -1) {
const typeExpr = rawKey.substring(0, typeSeparator);
const key = rawKey.substring(typeSeparator + 1);
const hasKnownType = typeExpr.split(',').map(type => type.replace(/\[.*\]$/, '')).some(type => ['manifest', 'index', 'manifest-descriptor', 'index-descriptor'].includes(type));
if (hasKnownType) {
return `index:${key}${rawValue}`;
}
}
return `index:${annotation}`;
};
const indexAnnotations = [];
if (inpSetMetaAnnotations && inpMetaAnnotations.length > 0) {
indexAnnotations.push(...inpMetaAnnotations.filter(annotation => annotation.length > 0).map(toIndexAnnotation));
}

const digests = [];
for (const key of Object.keys(inpBuildOutputs)) {
Expand All @@ -1006,6 +1030,7 @@ jobs:
const result = await new ImageTools().create({
sources: digests,
tags: tags,
annotations: indexAnnotations,
skipExec: !inpPush
});
if (inpPush) {
Expand Down
27 changes: 27 additions & 0 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -839,6 +839,9 @@ jobs:
INPUT_IMAGE-NAMES: ${{ inputs.meta-images }}
INPUT_TAG-NAMES: ${{ steps.meta.outputs.tag-names }}
INPUT_BUILD-OUTPUTS: ${{ toJSON(needs.build.outputs) }}
INPUT_ANNOTATIONS: ${{ inputs.annotations }}
INPUT_SET-META-ANNOTATIONS: ${{ inputs.set-meta-annotations }}
INPUT_META-ANNOTATIONS: ${{ steps.meta.outputs.annotations }}
with:
script: |
const { ImageTools } = require('@docker/actions-toolkit/lib/buildx/imagetools');
Expand All @@ -847,6 +850,29 @@ jobs:
const inpImageNames = core.getMultilineInput('image-names');
const inpTagNames = core.getMultilineInput('tag-names');
const inpBuildOutputs = JSON.parse(core.getInput('build-outputs'));
const inpAnnotations = core.getMultilineInput('annotations');
const inpSetMetaAnnotations = core.getBooleanInput('set-meta-annotations');
const inpMetaAnnotations = core.getMultilineInput('meta-annotations');

const toIndexAnnotation = annotation => {
const keyEnd = annotation.indexOf('=');
const rawKey = keyEnd === -1 ? annotation : annotation.substring(0, keyEnd);
const rawValue = keyEnd === -1 ? '' : annotation.substring(keyEnd);
const typeSeparator = rawKey.indexOf(':');
if (typeSeparator !== -1) {
const typeExpr = rawKey.substring(0, typeSeparator);
const key = rawKey.substring(typeSeparator + 1);
const hasKnownType = typeExpr.split(',').map(type => type.replace(/\[.*\]$/, '')).some(type => ['manifest', 'index', 'manifest-descriptor', 'index-descriptor'].includes(type));
if (hasKnownType) {
return `index:${key}${rawValue}`;
}
}
return `index:${annotation}`;
};
if (inpSetMetaAnnotations && inpMetaAnnotations.length > 0) {
inpAnnotations.push(...inpMetaAnnotations);
}
const indexAnnotations = inpAnnotations.filter(annotation => annotation.length > 0).map(toIndexAnnotation);

const digests = [];
for (const key of Object.keys(inpBuildOutputs)) {
Expand All @@ -869,6 +895,7 @@ jobs:
const result = await new ImageTools().create({
sources: digests,
tags: tags,
annotations: indexAnnotations,
skipExec: !inpPush
});
if (inpPush) {
Expand Down
Loading