setup-buildx-action/README.md

About

GitHub Action to set up Docker Buildx.

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

---

• Usage
  • Quick start
  • With QEMU
• Customizing
  • inputs
  • outputs
  • environment variables
• Keep up-to-date with GitHub Dependabot
• Limitation

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

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.