GitHub Action to set up Docker Buildx
Go to file
CrazyMax 86f43c11f1
update and split docs
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-18 02:34:19 +02:00
__tests__ support standalone mode and display version 2022-04-17 17:22:11 +02:00
.github Bump all Docker actions to latest major 2022-05-05 19:43:45 +02:00
dist skip setting buildkitd flags and config for remote driver 2022-09-16 18:12:29 +02:00
docs/advanced update and split docs 2022-09-18 02:34:19 +02:00
src skip setting buildkitd flags and config for remote driver 2022-09-16 18:12:29 +02:00
.dockerignore Enhance workflow 2021-04-02 01:19:20 +02:00
.editorconfig Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
.eslintrc.json chore: update dev dependencies and workflow 2022-03-21 13:43:41 +01:00
.gitattributes Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
.gitignore Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
.prettierrc.json Allow building buildx from source 2021-07-02 07:02:33 +02:00
action.yml Clarify description for install option 2022-05-26 18:23:16 -04:00
codecov.yml Allow building buildx from source 2021-07-02 07:02:33 +02:00
dev.Dockerfile Node 16 as default runtime 2022-03-21 13:50:20 +01:00
docker-bake.hcl chore: update dev dependencies and workflow 2022-03-21 13:43:41 +01:00
jest.config.ts chore: update dev dependencies and workflow 2022-03-21 13:43:41 +01:00
LICENSE Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
package.json Bump @actions/core from 1.8.2 to 1.9.1 2022-08-09 04:03:44 +00:00
README.md update and split docs 2022-09-18 02:34:19 +02:00
tsconfig.json chore: update dev dependencies and workflow 2022-03-21 13:43:41 +01:00
yarn.lock Bump @actions/core from 1.8.2 to 1.9.1 2022-08-09 04:03:44 +00:00

GitHub release GitHub marketplace CI workflow Test workflow Codecov

About

GitHub Action to set up Docker Buildx.

This action will create and boot a builder that can be used in the following steps of your workflow if you're using Buildx or the build-push action. By default, the docker-container driver will be used to be able to build multi-platform images and export cache using a BuildKit container.

Screenshot


Usage

name: ci

on:
  push:

jobs:
  buildx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        # Add support for more platforms with QEMU (optional)
        # https://github.com/docker/setup-qemu-action
        name: Set up QEMU
        uses: docker/setup-qemu-action@v2
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2

Advanced usage

Customizing

inputs

Following inputs can be used as step.with keys

Name Type Description
version String Buildx version. (eg. v0.3.0, latest, https://github.com/docker/buildx.git#master)
driver String Sets the builder driver to be used (default docker-container)
driver-opts CSV List of additional driver-specific options (eg. image=moby/buildkit:master)
buildkitd-flags String Flags for buildkitd daemon (since buildx v0.3.0)
install Bool Sets up docker build command as an alias to docker buildx (default false)
use Bool Switch to this builder instance (default true)
endpoint String Optional address for docker socket or context from docker context ls
config¹ String BuildKit config file
config-inline¹ String Same as config but inline
  • ¹ config and config-inline are mutually exclusive

CSV type must be a newline-delimited string

driver-opts: image=moby/buildkit:master
driver-opts: |
  image=moby/buildkit:master
  network=host  

outputs

Following outputs are available

Name Type Description
name String Builder name
driver String Builder driver
endpoint String Builder node endpoint
status String Builder node status
flags String Builder node flags (if applicable)
platforms String Builder node platforms available (comma separated)

environment variables

The following official docker environment variables are supported:

Name Type Default Description
DOCKER_CONFIG String ~/.docker The location of your client configuration files

Notes

BuildKit container logs

To display BuildKit container logs (when docker-container driver is used) you have to enable step debug logging, or you can also enable debugging in the setup-buildx action step:

  -
    name: Set up Docker Buildx
    uses: docker/setup-buildx-action@v2
    with:
      buildkitd-flags: --debug

Logs will be available at the end of a job:

BuildKit container logs

Keep up-to-date with GitHub Dependabot

Since Dependabot has native GitHub Actions support, to enable it on your GitHub repo all you need to do is add the .github/dependabot.yml file:

version: 2
updates:
  # Maintain dependencies for GitHub Actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "daily"