2020-08-18 23:54:41 +08:00
[](https://github.com/docker/setup-buildx-action/releases/latest)
[](https://github.com/marketplace/actions/docker-setup-buildx)
[](https://github.com/docker/setup-buildx-action/actions?workflow=ci)
[](https://github.com/docker/setup-buildx-action/actions?workflow=test)
2020-08-27 23:41:10 +08:00
[](https://codecov.io/gh/docker/setup-buildx-action)
2020-08-18 23:54:41 +08:00
2020-08-18 23:40:31 +08:00
## About
GitHub Action to set up Docker [Buildx ](https://github.com/docker/buildx ).
2020-08-29 23:50:15 +08:00
> :bulb: See also:
> * [login](https://github.com/docker/login-action) action
> * [setup-qemu](https://github.com/docker/setup-qemu-action) action
> * [build-push](https://github.com/docker/build-push-action) action
2020-08-20 03:35:25 +08:00
2020-08-19 19:24:24 +08:00
2020-08-18 23:40:31 +08:00
___
* [Usage ](#usage )
* [Quick start ](#quick-start )
* [With QEMU ](#with-qemu )
2020-08-29 23:50:15 +08:00
* [Install by default ](#install-by-default )
2020-08-18 23:40:31 +08:00
* [Customizing ](#customizing )
* [inputs ](#inputs )
* [outputs ](#outputs )
* [environment variables ](#environment-variables )
2020-08-20 23:26:41 +08:00
* [Keep up-to-date with GitHub Dependabot ](#keep-up-to-date-with-github-dependabot )
2020-08-18 23:40:31 +08:00
* [Limitation ](#limitation )
## Usage
### Quick start
```yaml
name: ci
on:
push:
jobs:
buildx:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Set up Docker Buildx
id: buildx
2020-09-09 06:21:06 +08:00
uses: docker/setup-buildx-action@v1
2020-08-18 23:40:31 +08:00
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 ](https://github.com/docker/setup-qemu-action ) action:
```yaml
name: ci
on:
push:
jobs:
buildx:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Set up QEMU
2020-09-09 06:21:06 +08:00
uses: docker/setup-qemu-action@v1
2020-08-18 23:40:31 +08:00
with:
platforms: all
-
name: Set up Docker Buildx
id: buildx
2020-09-09 06:21:06 +08:00
uses: docker/setup-buildx-action@v1
2020-08-18 23:40:31 +08:00
with:
version: latest
-
name: Available platforms
run: echo ${{ steps.buildx.outputs.platforms }}
```
2020-08-29 23:50:15 +08:00
### Install by default
Implemented with https://github.com/docker/buildx#setting-buildx-as-default-builder-in-docker-1903
```yaml
name: ci
on:
push:
jobs:
buildx:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
-
2020-09-09 06:21:06 +08:00
uses: docker/setup-buildx-action@v1
2020-08-29 23:50:15 +08:00
id: buildx
with:
install: true
-
name: Build
run: |
docker build . # will run buildx
```
2020-08-18 23:40:31 +08:00
## Customizing
### inputs
Following inputs can be used as `step.with` keys
2020-08-21 23:31:14 +08:00
| Name | Type | Description |
|--------------------|---------|-----------------------------------|
2020-09-06 22:37:52 +08:00
| `version` | String | [Buildx ](https://github.com/docker/buildx ) version. (eg. `v0.3.0` , `latest` ) |
2020-08-21 23:31:14 +08:00
| `driver` | String | Sets the [builder driver ](https://github.com/docker/buildx#--driver-driver ) to be used (default `docker-container` ) |
2020-09-06 22:37:52 +08:00
| `driver-opts` | CSV | List of additional [driver-specific options ](https://github.com/docker/buildx#--driver-opt-options ) (eg. `image=moby/buildkit:master` ) |
2020-09-04 03:02:36 +08:00
| `buildkitd-flags` | String | [Flags for buildkitd ](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md ) daemon (since [buildx v0.3.0 ](https://github.com/docker/buildx/releases/tag/v0.3.0 )) |
2020-08-21 23:31:14 +08:00
| `install` | Bool | Sets up `docker build` command as an alias to `docker buildx` (default `false` ) |
| `use` | Bool | Switch to this builder instance (default `true` ) |
2020-09-09 00:22:35 +08:00
| `endpoint` | String | [Optional address for docker socket ](https://github.com/docker/buildx#buildx-create-options-contextendpoint ) or context from `docker context ls` |
2020-08-18 23:40:31 +08:00
2020-09-03 22:23:15 +08:00
> `CSV` type must be a newline-delimited string
> ```yaml
> driver-opts: image=moby/buildkit:master
> ```
> ```yaml
> driver-opts: |
> image=moby/buildkit:master
> network=host
> ```
2020-08-18 23:40:31 +08:00
### 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 ](https://docs.docker.com/engine/reference/commandline/cli/#environment-variables ) are supported:
| Name | Type | Default | Description |
|-----------------|---------|-------------|-------------------------------------------------|
| `DOCKER_CONFIG` | String | `~/.docker` | The location of your client configuration files |
2020-08-20 23:26:41 +08:00
## Keep up-to-date with GitHub Dependabot
Since [Dependabot ](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot )
has [native GitHub Actions support ](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem ),
to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file:
```yaml
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
```
2020-08-18 23:40:31 +08:00
## Limitation
2020-08-19 00:07:14 +08:00
This action is only available for Linux [virtual environments ](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#supported-virtual-environments-and-hardware-resources ).
