Skip to content

feat(docker-build-push-image): support annotations #1513

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

Merged
merged 2 commits into from
Nov 10, 2025
Merged

feat(docker-build-push-image): support annotations #1513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39e3114
feat(docker-build-push-image): support annotations
martincostello Nov 10, 2025
1242238
fix(docker-build-push-image): match style
martincostello Nov 10, 2025
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
1 change: 1 addition & 0 deletions actions/docker-build-push-image/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ jobs:

| Name | Type | Description |
| ----------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `annotations` | String | List of custom annotations to add to the image as metadata. Passed to `docker/build-push-action`. |
| `build-args` | String | List of arguments necessary for the Docker image to be built. Passed to `docker/build-push-action`. |
| `build-contexts` | String | List of additional build contexts (e.g., name=path). Passed to `docker/build-push-action`. |
| `buildkitd-config` | String | The buildkitd config file to use. Defaults to `/etc/buildkitd.toml` if you're using Grafana's self-hosted runners. Passed to `docker/setup-buildx-action`. |
Expand Down
6 changes: 6 additions & 0 deletions actions/docker-build-push-image/action.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ name: Build and Push Docker Image
description: Composite action to push a docker image to GAR or DockerHub

inputs:
annotations:
description: |
List of custom annotations to add to the image as metadata (passed to `docker/build-push-action`).
Passed to `docker/build-push-action`.
build-args:
description: |
List of arguments necessary for the Docker image to be built.
Expand Down Expand Up @@ -264,6 +268,7 @@ runs:
id: meta
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
with:
annotations: ${{ inputs.annotations }}
images: ${{ steps.setup-vars.outputs.images }}
labels: ${{ inputs.labels }}
tags: ${{ inputs.tags }}
Expand Down Expand Up @@ -326,6 +331,7 @@ runs:
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
id: build
with:
annotations: ${{ steps.meta.outputs.annotations }}
build-args: ${{ inputs.build-args }}
build-contexts: ${{ inputs.build-contexts }}
cache-from: ${{ inputs.cache-from }}
Expand Down
Loading