GitHub Action to set up Docker Buildx
 
 
 
Go to file
CrazyMax edfb0fe620
Merge pull request #284 from docker/dependabot/npm_and_yarn/docker/actions-toolkit-0.14.0
build(deps): bump @docker/actions-toolkit from 0.13.0 to 0.14.0
2023-12-01 03:57:18 -08:00
.github chore: github form templates 2023-09-13 09:51:54 +02:00
__tests__ context: only append flags if we know the driver supports them 2023-06-28 09:30:10 -04:00
dist chore: update generated content 2023-12-01 12:55:15 +01:00
docs/advanced docs: updates 2023-02-24 03:22:30 +01:00
src context: only append flags if we know the driver supports them 2023-06-28 09:30:10 -04: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
.eslintignore chore: update dev dependencies 2023-09-09 18:21:41 +02:00
.eslintrc.json chore: update dev dependencies 2023-09-09 18:21:41 +02: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
LICENSE Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
README.md docs: bump actions to latest major 2023-09-12 14:18:18 +02:00
action.yml chore: node 20 as default runtime 2023-09-09 18:21:42 +02:00
codecov.yml Allow building buildx from source 2021-07-02 07:02:33 +02:00
dev.Dockerfile chore: update dev dependencies 2023-09-09 18:21:41 +02:00
docker-bake.hcl don't depend on the GitHub API to check release 2023-01-30 11:56:13 +01:00
jest.config.ts switch to actions-toolkit implementation 2023-02-25 13:27:17 +01:00
package.json build(deps): bump @docker/actions-toolkit from 0.13.0 to 0.14.0 2023-11-17 04:42:14 +00:00
tsconfig.json switch to actions-toolkit implementation 2023-02-25 13:27:17 +01:00
yarn.lock build(deps): bump @docker/actions-toolkit from 0.13.0 to 0.14.0 2023-11-17 04:42:14 +00:00

README.md

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@v4
      -
        # Add support for more platforms with QEMU (optional)
        # https://github.com/docker/setup-qemu-action
        name: Set up QEMU
        uses: docker/setup-qemu-action@v3
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

Configuring your builder

Customizing

inputs

The following inputs can be used as step.with keys:

List type is a newline-delimited string

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

CSV type must be a comma-delimited string

platforms: linux/amd64,linux/arm64
Name Type Default Description
version String Buildx version. (eg. v0.3.0, latest, https://github.com/docker/buildx.git#master)
driver String docker-container Sets the builder driver to be used
driver-opts List List of additional driver-specific options (eg. image=moby/buildkit:master)
buildkitd-flags String Flags for buildkitd daemon
install Bool false Sets up docker build command as an alias to docker buildx
use Bool true Switch to this builder instance
endpoint String Optional address for docker socket or context from docker context ls
platforms List/CSV Fixed platforms for current node. If not empty, values take priority over the detected ones.
config¹ String BuildKit config file
config-inline¹ String Same as config but inline
append YAML Append additional nodes to the builder
cleanup Bool true Cleanup temp files and remove builder at the end of a job
  • ¹ config and config-inline are mutually exclusive

outputs

The following outputs are available:

Name Type Description
name String Builder name
driver String Builder driver
platforms String Builder node platforms (preferred and/or available)
nodes JSON Builder nodes metadata

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

nodes output

[
  {
     "name": "builder-3820d274-502c-4498-ae24-d4c32b3023d90",
     "endpoint": "unix:///var/run/docker.sock",
     "driver-opts": [
       "network=host",
       "image=moby/buildkit:master"
     ],
    "status": "running",
    "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
    "buildkit": "3fab389",
    "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/386"
  }
]
Name Type Description
name String Node name
endpoint String Node endpoint
driver-opts List Options for the driver
status String Node status
buildkitd-flags String Flags for buildkitd daemon
buildkit String BuildKit version
platforms String Platforms available

Contributing

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