GitHub Action to build and push Docker images withBuildxwith full support of the features provided byMoby BuildKitbuilder toolkit. This includes multi-platform build, secrets, remote cache, etc.and different builder deployment/namespacing options.

• Usage
  • Git context
  • Path context
• Examples
• Summaries
• Customizing
  • inputs
  • outputs
  • environment variables
• Troubleshooting
• Contributing

In the examples below we are also using 3 other actions:

• setup-buildx action willcreate and boot a builder using by default thedocker-container driver.This isnot required but recommended using it to be able to buildmulti-platform images, export cache, etc.
• setup-qemu action can beuseful if you want to add emulation support with QEMU to be able to buildagainst more platforms.
• login action will take care tolog in against a Docker registry.

By default, this action uses theGit context,so you don't need to use theactions/checkoutaction to check out the repository as this will be done directly byBuildKit.

The git reference will be based on theevent that triggered your workflowand will result in the following context:https://github.com/<owner>/<repo>.git#<ref>.

name:cion:push:jobs:docker:runs-on:ubuntu-lateststeps:      -name:Login to Docker Hubuses:docker/login-action@v3with:username:${{ vars.DOCKERHUB_USERNAME }}password:${{ secrets.DOCKERHUB_TOKEN }}      -name:Set up QEMUuses:docker/setup-qemu-action@v3      -name:Set up Docker Buildxuses:docker/setup-buildx-action@v3      -name:Build and pushuses:docker/build-push-action@v6with:push:truetags:user/app:latest

Be careful becauseany file mutation in the steps that precede the build stepwill be ignored, including processing of the.dockerignore file sincethe context is based on the Git reference. However, you can use thePath context using thecontext input alongsidetheactions/checkout action to removethis restriction.

Default Git context can also be provided using theHandlebars templateexpression{{defaultContext}}. Here we can use it to provide a subdirectoryto the default Git context:

      -name:Build and pushuses:docker/build-push-action@v6with:context:"{{defaultContext}}:mysubdir"push:truetags:user/app:latest

Building from the current repository automatically uses theGitHub Token,so it does not need to be passed. If you want to authenticate against anotherprivate repository, you have to use asecretnamedGIT_AUTH_TOKEN to be able to authenticate against it with Buildx:

      -name:Build and pushuses:docker/build-push-action@v6with:push:truetags:user/app:latestsecrets:|            GIT_AUTH_TOKEN=${{ secrets.MYTOKEN }}

name:cion:push:jobs:docker:runs-on:ubuntu-lateststeps:      -name:Checkoutuses:actions/checkout@v5      -name:Login to Docker Hubuses:docker/login-action@v3with:username:${{ vars.DOCKERHUB_USERNAME }}password:${{ secrets.DOCKERHUB_TOKEN }}      -name:Set up QEMUuses:docker/setup-qemu-action@v3      -name:Set up Docker Buildxuses:docker/setup-buildx-action@v3      -name:Build and pushuses:docker/build-push-action@v6with:context:.push:truetags:user/app:latest

• Multi-platform image
• Secrets
• Push to multi-registries
• Manage tags and labels
• Cache management
• Export to Docker
• Test before push
• Validating build configuration
• Local registry
• Share built image between jobs
• Named contexts
• Copy image between registries
• Update Docker Hub repo description
• SBOM and provenance attestations
• Annotations
• Reproducible builds

This action generates ajob summarythat provides a detailed overview of the build execution. The summary shows anoverview of all the steps executed during the build, including the build inputsand eventual errors.

The summary also includes a link for downloading the build record withadditional details about the build, including build stats, logs, outputs, andmore. The build record can be imported to Docker Desktop for inspecting thebuild in greater detail.

-uses:actions/download-artifact@v4with:pattern:"!*.dockerbuild"

Summaries are enabled by default, but can be disabled with theDOCKER_BUILD_SUMMARYenvironment variable.

For more information about summaries, refer to thedocumentation.

The following inputs can be used asstep.with keys:

List type is a newline-delimited string

cache-from:|  user/app:cache  type=local,src=path/to/dir

CSV type is a comma-delimited string

tags:name/app:latest,name/app:1.0.0

The following outputs are available:

SeeTROUBLESHOOTING.md

Want to contribute? Awesome! You can find information about contributing tothis project in theCONTRIBUTING.md

Contributors44 (44)

• Start a discussion
• Open an issue38 (38)
• Pull requests11 (11)
• View source code
• Security policy
• Report abuse

Build and push Docker images is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Tags

Resources