build-push-action/setup-buildx/README.md

3.5 KiB

About

GitHub Action to set up Docker Buildx.


Usage

Quick start

name: ci

on:
  pull_request:
    branches: master
  push:
    branches: master
    tags:

jobs:
  buildx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Set up Docker Buildx
        id: buildx
        uses: docker/actions/setup-buildx@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:
  pull_request:
    branches: master
  push:
    branches: master
    tags:

jobs:
  buildx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Set up QEMU
        uses: docker/actions/setup-qemu@v1
        with:
          platforms: all
      -
        name: Set up Docker Buildx
        id: buildx
        uses: docker/actions/setup-buildx@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 the one installed on the runner 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. e.g. image=moby/buildkit:master
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.