| package | Package name; e.g. backend, frontend | yes | — |
| build_context | Build context, not required for self-contained package/default directory | — | — |
| build_file | Dockerfile with path, not required for self-contained package/default directory | — | — |
| sbom | Generate a Software Bill of Materials (SBOM) for the container image. Enabled by default for better security practices. | — | true |
| tag_fallback | Where to pull default images from; e.g. prod, test | — | — |
| tags | Default tag(s); e.g. pr#, test, prod.
Supports multiline input for multiple tags.
Example: |
pr123
demo
test
| — | ${{ github.event.number }} |
| triggers | Paths used to trigger a build; e.g. ('./backend/' './frontend/) | — | — |
| build_args | A list of build-time variables, generally not advisable | — | BUILDKIT_INLINE_CACHE=1 |
| diff_branch | Branch to diff against | — | ${{ github.event.repository.default_branch }} |
| repository | Non-default repo to clone | — | ${{ github.repository }} |
| github_token | Specify token (GH or PAT), instead of inheriting one from the calling workflow | — | ${{ github.token }} |
| username | Username for registry login; defaults to github.actor | — | ${{ github.actor }} |
| secrets | Multiline input for secrets to mount.
https://docs.docker.com/build/ci/github-actions/secrets/#secret-mounts
Example: |
MY_SECRET=secret_value
ANOTHER_SECRET=another_value
| — | — |
| metadata_tags | Enable automatic tag and label generation using docker/metadata-action.
When enabled, generates tags and labels using the default rules in 'metadata_tag_rules', which you can override.
String value, not boolean. Set to 'true' to enable (default).
| — | true |
| metadata_flavor | Flavor configuration for metadata-action (e.g., 'latest=true').
Only used when metadata_tags is enabled.
See: https://github.com/docker/metadata-action#flavor-input
| — | — |
| metadata_tag_rules | Custom tag rules for metadata-action.
Only used when metadata_tags is enabled.
Example: |
type=ref,event=branch
type=semver,pattern={{version}}
See: https://github.com/docker/metadata-action#tags-input
| — | type=sha,format=short
type=ref,event=branch
type=ref,event=pr
type=raw,value=latest,enable={{is_default_branch}}
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
|