2020-08-19 19:46:12 +00:00
[](https://github.com/docker/build-push-action/releases/latest)
2020-09-08 22:03:42 +00:00
[](https://github.com/marketplace/actions/build-and-push-docker-images)
2020-08-19 19:46:12 +00:00
[](https://github.com/docker/build-push-action/actions?workflow=ci)
[](https://github.com/docker/build-push-action/actions?workflow=test)
2020-09-08 21:34:53 +00:00
[](https://codecov.io/gh/docker/build-push-action)
2020-08-19 19:46:12 +00:00
2020-08-15 22:36:41 +00:00
## About
2020-03-05 16:28:11 +00:00
2020-09-02 08:07:11 +00:00
GitHub Action to build and push Docker images with [Buildx ](https://github.com/docker/buildx ).
2020-03-16 15:13:04 +00:00
2020-08-29 14:10:05 +00:00
> :bulb: See also:
> * [login](https://github.com/docker/login-action) action
> * [setup-buildx](https://github.com/docker/setup-buildx-action) action
> * [setup-qemu](https://github.com/docker/setup-qemu-action) action
2020-08-19 19:35:36 +00:00
2020-08-19 19:46:12 +00:00
2020-08-15 22:36:41 +00:00
___
2020-03-05 16:28:11 +00:00
2020-08-15 22:36:41 +00:00
* [Usage ](#usage )
2020-09-02 08:07:11 +00:00
* [Git context ](#git-context )
* [Path context ](#path-context )
2020-08-29 15:46:56 +00:00
* [Isolated builders ](#isolated-builders )
2020-08-18 20:54:44 +00:00
* [Multi-platform image ](#multi-platform-image )
2020-09-12 18:40:12 +00:00
* [Advanced usage ](#advanced-usage )
2020-09-09 14:18:06 +00:00
* [Local registry ](#local-registry )
2020-08-29 14:10:05 +00:00
* [Leverage GitHub cache ](#leverage-github-cache )
2020-08-18 20:54:44 +00:00
* [Complete workflow ](#complete-workflow )
2020-09-09 23:14:41 +00:00
* [Update DockerHub repo description ](#update-dockerhub-repo-description )
2020-08-15 22:36:41 +00:00
* [Customizing ](#customizing )
* [inputs ](#inputs )
* [outputs ](#outputs )
2020-09-21 16:22:47 +00:00
* [Troubleshooting ](#troubleshooting )
2020-08-20 15:25:55 +00:00
* [Keep up-to-date with GitHub Dependabot ](#keep-up-to-date-with-github-dependabot )
2020-08-15 22:36:41 +00:00
* [Limitation ](#limitation )
2020-03-05 16:28:11 +00:00
2020-08-15 22:36:41 +00:00
## Usage
2020-03-05 16:28:11 +00:00
2020-08-16 03:53:50 +00:00
This action uses our [setup-buildx ](https://github.com/docker/setup-buildx-action ) action that extends the
`docker build` command named [buildx ](https://github.com/docker/buildx ) with the full support of the features
2020-08-19 19:35:36 +00:00
provided by [Moby BuildKit ](https://github.com/moby/buildkit ) builder toolkit. This includes multi-arch build,
2020-08-16 03:53:50 +00:00
build-secrets, remote cache, etc. and different builder deployment/namespacing options.
2020-03-05 16:28:11 +00:00
2020-09-02 08:07:11 +00:00
### Git context
2020-09-12 18:40:12 +00:00
The default behavior of this action is to use the [Git context invoked by your workflow ](https://github.com/docker/build-push-action/blob/master/src/context.ts#L35 ).
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
2020-08-15 22:36:41 +00:00
name: ci
on:
push:
branches: master
jobs:
2020-08-17 20:18:15 +00:00
main:
runs-on: ubuntu-latest
steps:
2020-09-05 03:18:00 +00:00
-
name: Set up QEMU
2020-09-08 22:32:40 +00:00
uses: docker/setup-qemu-action@v1
2020-08-17 20:18:15 +00:00
-
name: Set up Docker Buildx
2020-09-08 22:32:40 +00:00
uses: docker/setup-buildx-action@v1
2020-08-17 20:18:15 +00:00
-
name: Login to DockerHub
2020-08-27 13:08:11 +00:00
uses: docker/login-action@v1
2020-08-17 20:18:15 +00:00
with:
2020-09-10 16:46:50 +00:00
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
2020-08-17 20:18:15 +00:00
-
name: Build and push
id: docker_build
uses: docker/build-push-action@v2
with:
push: true
2020-08-18 20:54:44 +00:00
tags: user/app:latest
2020-08-17 20:18:15 +00:00
-
name: Image digest
run: echo ${{ steps.docker_build.outputs.digest }}
2020-09-21 16:22:47 +00:00
```
< / details >
2020-08-17 20:18:15 +00:00
2020-09-02 08:44:27 +00:00
If you use this action in a private repository, you have to pass the [GitHub Token ](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token )
as a secret named `GIT_AUTH_TOKEN` to be able to authenticate against it with buildx:
2020-09-02 08:07:11 +00:00
```yaml
-
name: Build and push
id: docker_build
uses: docker/build-push-action@v2
with:
push: true
tags: user/app:latest
secrets: |
GIT_AUTH_TOKEN=${{ github.token }}
```
2020-09-21 16:22:47 +00:00
> :warning: Subdir for Git context is [not yet supported](https://github.com/docker/build-push-action/issues/120).
> For the moment you can use the [path context](#path-context).
2020-09-02 08:07:11 +00:00
### Path context
You can also use the `PATH` context alongside the [`actions/checkout` ](https://github.com/actions/checkout/ ) action.
2020-08-29 15:46:56 +00:00
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
name: ci
on:
push:
branches: master
jobs:
path-context:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Set up QEMU
uses: docker/setup-qemu-action@v1
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
-
name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Build and push
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
platforms: linux/amd64,linux/arm64,linux/386
push: true
tags: user/app:latest
```
< / details >
2020-09-02 08:07:11 +00:00
### Isolated builders
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
name: ci
on:
push:
branches: master
jobs:
multi-builders:
runs-on: ubuntu-latest
steps:
-
uses: docker/setup-buildx-action@v1
id: builder1
-
uses: docker/setup-buildx-action@v1
id: builder2
-
name: Builder 1 name
run: echo ${{ steps.builder1.outputs.name }}
-
name: Builder 2 name
run: echo ${{ steps.builder2.outputs.name }}
-
name: Build against builder1
uses: docker/build-push-action@v2
with:
builder: ${{ steps.builder1.outputs.name }}
target: mytarget1
-
name: Build against builder2
uses: docker/build-push-action@v2
with:
builder: ${{ steps.builder2.outputs.name }}
target: mytarget2
```
< / details >
2020-08-29 15:46:56 +00:00
2020-08-17 20:18:15 +00:00
### Multi-platform image
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
name: ci
on:
push:
branches: master
jobs:
multi:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Set up QEMU
uses: docker/setup-qemu-action@v1
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
-
name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Build and push
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64,linux/ppc64le,linux/s390x
push: true
tags: |
user/app:latest
user/app:1.0.0
```
< / details >
2020-04-22 15:34:18 +00:00
2020-09-12 18:40:12 +00:00
## Advanced usage
2020-09-05 03:18:00 +00:00
### Local registry
For testing purposes you may need to create a [local registry ](https://hub.docker.com/_/registry ) to push images into.
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
name: ci
on:
push:
branches: master
jobs:
local-registry:
runs-on: ubuntu-latest
services:
registry:
image: registry:2
ports:
- 5000:5000
steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v1
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
with:
driver-opts: network=host
-
name: Build and push to local registry
uses: docker/build-push-action@v2
with:
push: true
tags: localhost:5000/name/app:latest
-
name: Inspect
run: |
docker buildx imagetools inspect localhost:5000/name/app:latest
```
< / details >
2020-09-05 03:18:00 +00:00
2020-08-29 14:10:05 +00:00
### Leverage GitHub cache
You can leverage [GitHub cache ](https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows )
2020-09-09 23:14:41 +00:00
using [actions/cache ](https://github.com/actions/cache ) with this action.
2020-08-29 14:10:05 +00:00
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
name: ci
on:
push:
branches: master
jobs:
github-cache:
runs-on: ubuntu-latest
steps:
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
-
name: Cache Docker layers
uses: actions/cache@v2
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-${{ github.sha }}
restore-keys: |
${{ runner.os }}-buildx-
-
name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Build and push
uses: docker/build-push-action@v2
with:
push: true
tags: user/app:latest
cache-from: type=local,src=/tmp/.buildx-cache
cache-to: type=local,dest=/tmp/.buildx-cache
```
< / details >
2020-08-29 14:10:05 +00:00
2020-09-12 18:40:12 +00:00
### Complete workflow
2020-09-10 20:24:13 +00:00
If you come from [`v1` ](https://github.com/docker/build-push-action/tree/releases/v1#readme ) and you want an
2020-09-11 23:44:53 +00:00
"automatic" tag management through Git reference and [OCI Image Format Specification ](https://github.com/opencontainers/image-spec/blob/master/annotations.md )
for labels, you will have to do it in a dedicated step [for now ](https://github.com/docker/build-push-action/issues/116 ).
2020-09-10 20:24:13 +00:00
2020-09-12 18:40:12 +00:00
The following workflow with the `Prepare` step will generate some [outputs ](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjobs_idoutputs )
to handle tags and labels based on GitHub actions events. This is just an example to show many cases that you
might want to use:
| Event | Ref | Commit SHA | Docker Tag | Pushed |
|-----------------|-------------------------------|------------|------------------------------------|--------|
| `schedule` | | | `nightly` | Yes |
| `pull_request` | `refs/pull/2/merge` | `a123b57` | `pr-2` | No |
| `push` | `refs/heads/<default_branch>` | `676cae2` | `sha-676cae2` , `edge` | Yes |
2020-09-17 11:27:14 +00:00
| `push` | `refs/heads/dev` | `cf20257` | `sha-cf20257` , `dev` | Yes |
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-a5df687` , `my-branch` | Yes |
| `push tag` | `refs/tags/v1.2.3` | | `v1.2.3` , `v1.2` , `v1` , `latest` | Yes |
2020-09-10 20:24:13 +00:00
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
name: ci
2020-09-10 20:24:13 +00:00
2020-09-21 16:22:47 +00:00
on:
schedule:
- cron: '0 10 * * *' # everyday at 10am
push:
branches:
- '**'
tags:
- 'v*.*.*'
pull_request:
jobs:
docker:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Prepare
id: prep
run: |
DOCKER_IMAGE=name/app
VERSION=noop
if [ "${{ github.event_name }}" = "schedule" ]; then
VERSION=nightly
elif [[ $GITHUB_REF == refs/tags/* ]]; then
VERSION=${GITHUB_REF#refs/tags/}
elif [[ $GITHUB_REF == refs/heads/* ]]; then
VERSION=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's#/+#-#g')
if [ "${{ github.event.repository.default_branch }}" = "$VERSION" ]; then
VERSION=edge
fi
elif [[ $GITHUB_REF == refs/pull/* ]]; then
VERSION=pr-${{ github.event.number }}
2020-09-11 23:44:53 +00:00
fi
2020-09-21 16:22:47 +00:00
TAGS="${DOCKER_IMAGE}:${VERSION}"
if [[ $VERSION =~ ^v[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
MINOR=${VERSION%.*}
MAJOR=${MINOR%.*}
TAGS="$TAGS,${DOCKER_IMAGE}:${MINOR},${DOCKER_IMAGE}:${MAJOR},${DOCKER_IMAGE}:latest"
elif [ "${{ github.event_name }}" = "push" ]; then
TAGS="$TAGS,${DOCKER_IMAGE}:sha-${GITHUB_SHA::8}"
fi
echo ::set-output name=version::${VERSION}
echo ::set-output name=tags::${TAGS}
echo ::set-output name=created::$(date -u +'%Y-%m-%dT%H:%M:%SZ')
-
name: Set up QEMU
uses: docker/setup-qemu-action@v1
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
-
name: Login to DockerHub
if: github.event_name != 'pull_request'
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Build and push
id: docker_build
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
platforms: linux/amd64,linux/arm64,linux/386
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.prep.outputs.tags }}
labels: |
org.opencontainers.image.title=${{ github.event.repository.name }}
org.opencontainers.image.description=${{ github.event.repository.description }}
org.opencontainers.image.url=${{ github.event.repository.html_url }}
org.opencontainers.image.source=${{ github.event.repository.clone_url }}
org.opencontainers.image.version=${{ steps.prep.outputs.version }}
org.opencontainers.image.created=${{ steps.prep.outputs.created }}
org.opencontainers.image.revision=${{ github.sha }}
org.opencontainers.image.licenses=${{ github.event.repository.license.spdx_id }}
```
< / details >
2020-08-16 17:41:44 +00:00
2020-09-09 23:14:41 +00:00
### Update DockerHub repo description
You can update the [Docker Hub repository description ](https://docs.docker.com/docker-hub/repos/ ) using
a third-party action called [Docker Hub Description ](https://github.com/peter-evans/dockerhub-description )
with this action.
2020-09-21 16:22:47 +00:00
< details >
< summary > < b > Show workflow< / b > < / summary >
```yaml
name: ci
on:
push:
branches: master
jobs:
main:
runs-on: ubuntu-latest
steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v1
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
-
name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Build and push
uses: docker/build-push-action@v2
with:
push: true
tags: user/app:latest
-
name: Update repo description
uses: peter-evans/dockerhub-description@v2
env:
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
DOCKERHUB_REPOSITORY: user/app
```
< / details >
2020-09-09 23:14:41 +00:00
2020-08-15 22:36:41 +00:00
## Customizing
2020-03-05 16:28:11 +00:00
2020-08-15 22:36:41 +00:00
### inputs
2020-03-05 16:28:11 +00:00
2020-08-15 22:36:41 +00:00
Following inputs can be used as `step.with` keys
2020-03-05 16:28:11 +00:00
2020-08-21 15:31:03 +00:00
| Name | Type | Description |
|---------------------|---------|------------------------------------|
| `builder` | String | Builder instance (see [setup-buildx ](https://github.com/docker/setup-buildx-action ) action) |
2020-09-02 08:07:11 +00:00
| `context` | String | Build's context is the set of files located in the specified [`PATH` or `URL` ](https://docs.docker.com/engine/reference/commandline/build/ ) (default [Git context ](#git-context )) |
| `file` | String | Path to the Dockerfile (default `Dockerfile` ) |
2020-08-21 15:31:03 +00:00
| `build-args` | List | List of build-time variables |
| `labels` | List | List of metadata for an image |
| `tags` | List | List of tags |
| `pull` | Bool | Always attempt to pull a newer version of the image (default `false` ) |
| `target` | String | Sets the target stage to build |
| `allow` | List | List of [extra privileged entitlement ](https://github.com/docker/buildx#--allowentitlement ) (eg. `network.host,security.insecure` ) |
| `no-cache` | Bool | Do not use cache when building the image (default `false` ) |
| `platforms` | List | List of [target platforms ](https://github.com/docker/buildx#---platformvaluevalue ) for build |
| `load` | Bool | [Load ](https://github.com/docker/buildx#--load ) is a shorthand for `--output=type=docker` (default `false` ) |
| `push` | Bool | [Push ](https://github.com/docker/buildx#--push ) is a shorthand for `--output=type=registry` (default `false` ) |
2020-08-29 15:15:26 +00:00
| `outputs` | CSV | List of [output destinations ](https://github.com/docker/buildx#-o---outputpath-typetypekeyvalue ) (format: `type=local,dest=path` ) |
2020-09-02 08:44:27 +00:00
| `cache-from` | CSV | List of [external cache sources ](https://github.com/docker/buildx#--cache-fromnametypetypekeyvalue ) (eg. `type=local,src=path/to/dir` ) |
| `cache-to` | CSV | List of [cache export destinations ](https://github.com/docker/buildx#--cache-tonametypetypekeyvalue ) (eg. `type=local,dest=path/to/dir` ) |
2020-09-02 08:07:11 +00:00
| `secrets` | CSV | List of secrets to expose to the build (eg. `key=value` , `GIT_AUTH_TOKEN=mytoken` ) |
2020-08-17 00:32:27 +00:00
2020-08-29 15:15:26 +00:00
> `List` type can be a comma or newline-delimited string
2020-08-17 00:32:27 +00:00
> ```yaml
> tags: name/app:latest,name/app:1.0.0
> ```
> ```yaml
> tags: |
> name/app:latest
> name/app:1.0.0
> ```
2020-03-05 16:28:11 +00:00
2020-08-29 15:15:26 +00:00
> `CSV` type must be a newline-delimited string
> ```yaml
> cache-from: user/app:cache
> ```
> ```yaml
> cache-from: |
> user/app:cache
> type=local,src=path/to/dir
> ```
2020-08-15 22:36:41 +00:00
### outputs
2020-03-05 16:28:11 +00:00
2020-08-15 22:36:41 +00:00
Following outputs are available
2020-03-05 16:28:11 +00:00
2020-08-15 22:36:41 +00:00
| Name | Type | Description |
|---------------|---------|---------------------------------------|
| `digest` | String | Image content-addressable identifier also called a digest |
2020-03-05 16:28:11 +00:00
2020-09-21 16:22:47 +00:00
## Troubleshooting
While pushing to a registry, you may encounter these kinds of issues:
* `failed commit on ref "layer-sha256:...": invalid content digest in response: invalid checksum digest format`
* `failed commit on ref "layer-sha256:...": no response`
* `failed commit on ref "manifest-sha256:...": unexpected status: 401 Unauthorized`
* `unexpected response: 401 Unauthorized`
These issues are not directly related to this action but are rather linked to [buildx ](https://github.com/docker/buildx ),
[buildkit ](https://github.com/moby/buildkit ), [containerd ](https://github.com/containerd/containerd ) or the registry
on which you're pushing your image. The quality of error message depends on the registry and are usually not very informative.
To help you solve this, you should first enable debugging in the
[setup-buildx action step ](https://github.com/docker/setup-buildx-action ):
```yaml
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
with:
buildkitd-flags: --debug
```
Next you can test pushing with containerd using [this workflow ](https://github.com/crazy-max/ghaction-setup-containerd#build-and-push-docker-image ).
Do not forget to set `ctr --debug` for the pushing step. If it works then open an issue on
[buildkit ](https://github.com/moby/buildkit ) repository.
2020-08-20 15:25:55 +00: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-15 22:36:41 +00:00
## Limitation
2020-03-05 16:28:11 +00:00
2020-08-15 22:36:41 +00:00
This action is only available for Linux [virtual environments ](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources ).
