GitHub Action to set up Docker Buildx
Go to file
Justin Cormack 4ae16d33b3
Merge pull request #8 from crazy-max/codecov
Enable Codecov and upload coverage
2020-08-27 16:48:44 +01:00
__tests__ Add container based dev flow (#4) 2020-08-26 23:48:38 +00:00
.github Enable Codecov and upload coverage 2020-08-27 17:41:10 +02:00
dist support for docker driver 2020-08-26 17:49:36 -07:00
hack Add container based dev flow (#4) 2020-08-26 23:48:38 +00:00
src support for docker driver 2020-08-26 17:49:36 -07:00
.editorconfig Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +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 Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
action.yml Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
CHANGELOG.md Update CHANGELOG 2020-08-26 17:37:33 +02:00
docker-bake.hcl Add container based dev flow (#4) 2020-08-26 23:48:38 +00:00
Dockerfile dockerfile: fix validate-yarn target 2020-08-26 18:31:18 -07:00
jest.config.js Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
LICENSE Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
package.json Bump @actions/core from 1.2.4 to 1.2.5 2020-08-27 04:27:16 +00:00
README.md Enable Codecov and upload coverage 2020-08-27 17:41:10 +02:00
tsconfig.json Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
yarn.lock Bump @actions/core from 1.2.4 to 1.2.5 2020-08-27 04:27:16 +00:00

GitHub release GitHub marketplace CI workflow Test workflow Codecov

About

GitHub Action to set up Docker Buildx.

💡 See also our build-push and setup-qemu actions

Screenshot


Usage

Quick start

name: ci

on:
  push:

jobs:
  buildx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Set up Docker Buildx
        id: buildx
        uses: docker/setup-buildx-action@v1
        with:
          version: latest
      -
        name: Builder instance name
        run: echo ${{ steps.buildx.outputs.name }}
      -
        name: Available platforms
        run: echo ${{ steps.buildx.outputs.platforms }}

With QEMU

If you want support for more platforms you can use our setup-qemu action:

name: ci

on:
  push:

jobs:
  buildx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Set up QEMU
        uses: docker/setup-qemu-action@v1
        with:
          platforms: all
      -
        name: Set up Docker Buildx
        id: buildx
        uses: docker/setup-buildx-action@v1
        with:
          version: latest
      -
        name: Available platforms
        run: echo ${{ steps.buildx.outputs.platforms }}

Customizing

inputs

Following inputs can be used as step.with keys

Name Type Description
version String Buildx version. (e.g. v0.3.0, latest)
driver String Sets the builder driver to be used (default docker-container)
driver-opt String Passes additional driver-specific options
buildkitd-flags String Flags for buildkitd daemon
install Bool Sets up docker build command as an alias to docker buildx (default false)
use Bool Switch to this builder instance (default true)

outputs

Following outputs are available

Name Type Description
name String Builder instance name
platforms String Available platforms (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

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"

Limitation

This action is only available for Linux virtual environments.