README.md

About

GitHub Action to use Docker Buildx Bake as a high-level build command.

---

• Usage
  • Path context
  • Git context
• Summaries
• Customizing
  • inputs
  • outputs
  • environment variables
• Subactions
  • list-targets
• Contributing

Usage

Path context

By default, this action will use the local bake definition (source: .), so you need to use the actions/checkout action to check out the repository.

name: ci

on:
  push:
    branches:
      - 'master'

jobs:
  bake:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v4
      -
        name: Login to DockerHub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3
      -
        name: Build and push
        uses: docker/bake-action@v5
        with:
          push: true

Git context

Git context can be provided using the source input. This means that you don't need to use the actions/checkout action to check out the repository as BuildKit will do this directly.

name: ci

on:
  push:
    branches:
      - 'master'

jobs:
  bake:
    runs-on: ubuntu-latest
    steps:
      -
        name: Login to DockerHub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3
      -
        name: Build and push
        uses: docker/bake-action@v5
        with:
          source: "${{ github.server_url }}/${{ github.repository }}.git#${{ github.ref }}"
          push: true

Be careful because any file mutation in the steps that precede the build step will be ignored, including processing of the .dockerignore file since the context is based on the Git reference. However, you can use the Path context alongside the actions/checkout action to remove this restriction.

Default Git context can also be provided using the Handlebars template expression {{defaultContext}}. Here we can use it to provide a subdirectory to the default Git context:

      -
        name: Build and push
        uses: docker/bake-action@v5
        with:
          source: "{{defaultContext}}:mysubdir"
          push: true

Building from the current repository automatically uses the GITHUB_TOKEN secret that GitHub automatically creates for workflows, so you don't need to pass that manually. If you want to authenticate against another private repository for remote definitions, you can set the BUILDX_BAKE_GIT_AUTH_TOKEN environment variable.

Note

Supported since Buildx 0.14.0

      -
        name: Build and push
        uses: docker/bake-action@v5
        with:
          source: "${{ github.server_url }}/${{ github.repository }}.git#${{ github.ref }}"
          push: true
        env:
          BUILDX_BAKE_GIT_AUTH_TOKEN: ${{ secrets.MYTOKEN }}

Summaries

This action generates a job summary that provides a detailed overview of the build execution. The summary shows an overview of all the steps executed during the build, including the build inputs, bake definition, and eventual errors.

The summary also includes a link for downloading a build record archive with additional details about the build execution for all the bake targets, including build stats, logs, outputs, and more. The build record can be imported to Docker Desktop for inspecting the build in greater detail.

Summaries are enabled by default, but can be disabled with the DOCKER_BUILD_SUMMARY environment variable.

For more information about summaries, refer to the documentation.

Customizing

inputs

The following inputs can be used as step.with keys

List type is a newline-delimited string

set: target.args.mybuildarg=value

set: |
  target.args.mybuildarg=value
  foo*.args.mybuildarg=value

CSV type is a comma-delimited string

targets: default,release

Name	Type	Description
builder	String	Builder instance (see setup-buildx action)
source	String	Context to build from. Can be either local (.) or a remote bake definition
allow	List/CSV	Allow build to access specified resources (e.g., network.host)
files	List/CSV	List of bake definition files
workdir	String	Working directory of execution
targets	List/CSV	List of bake targets (default target used if empty)
no-cache	Bool	Do not use cache when building the image (default false)
pull	Bool	Always attempt to pull a newer version of the image (default false)
load	Bool	Load is a shorthand for --set=*.output=type=docker (default false)
provenance	Bool/String	Provenance is a shorthand for --set=*.attest=type=provenance
push	Bool	Push is a shorthand for --set=*.output=type=registry (default false)
sbom	Bool/String	SBOM is a shorthand for --set=*.attest=type=sbom
set	List	List of targets values to override (e.g., targetpattern.key=value)
github-token	String	API token used to authenticate to a Git repository for remote definitions (default ${{ github.token }})

outputs

The following outputs are available

Name	Type	Description
metadata	JSON	Build result metadata

environment variables

Name	Type	Default	Description
DOCKER_BUILD_CHECKS_ANNOTATIONS	Bool	true	If false, GitHub annotations are not generated for build checks
DOCKER_BUILD_SUMMARY	Bool	true	If false, build summary generation is disabled
DOCKER_BUILD_RECORD_UPLOAD	Bool	true	If false, build record upload as GitHub artifact is disabled
DOCKER_BUILD_RECORD_RETENTION_DAYS	Number		Duration after which build record artifact will expire in days. Defaults to repository/org retention settings if unset or 0

Subactions

• list-targets

Contributing

Want to contribute? Awesome! You can find information about contributing to this project in the CONTRIBUTING.md