GitHub Action to set up Docker Buildx
Go to file
CrazyMax 4da653a70b
Update README
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-08-19 13:24:24 +02:00
__tests__ Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
.github Update README 2020-08-19 13:24:24 +02:00
dist Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
src Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02: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
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 Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
README.md Update README 2020-08-19 13:24:24 +02:00
tsconfig.json Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00
yarn.lock Initial commit (docker/build-push-action#87) 2020-08-18 17:40:31 +02:00

GitHub release GitHub marketplace CI workflow Test workflow

About

GitHub Action to set up Docker Buildx.

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 Default Description
version String Buildx version. (e.g. v0.3.0, latest)
driver String docker-container Sets the builder driver to be used
driver-opt String Passes additional driver-specific options
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

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

Limitation

This action is only available for Linux virtual environments.