build-push-action/README.md
CrazyMax 78a1e0d9a3
Remove builder v1 support
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-08-16 05:53:50 +02:00

4.2 KiB

About

GitHub Action to build and push Docker images.


Usage

This action uses our setup-buildx action that extends the docker build command named buildx with the full support of the features provided by Moby BuildKit builder toolkik. This includes multi-arch build, build-secrets, remote cache, etc. and different builder deployment/namespacing options.

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 QEMU
        uses: docker/setup-qemu-action@v1
        with:
          platforms: all
      -
        name: Set up Docker Buildx
        id: buildx
        uses: docker/setup-buildx-action@v1
        with:
          install: true
      -
        name: Login to DockerHub
        uses: docker/login-action@v1
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}
      -
        name: Build and push
        uses: docker/build-push-action@v2
        with:
          builder: ${{ steps.buildx.outputs.name }}
          platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64,linux/386,linux/ppc64le,linux/s390x
          push: true
          tags: |
            user/app:latest
            user/app:1.0.0            

Customizing

inputs

Following inputs can be used as step.with keys

Name Type Default Description
builder String Builder instance
context String . Build's context is the set of files located in the specified PATH or URL
file String ./Dockerfile Path to the Dockerfile.
build-args String Newline-delimited list of build-time variables
labels String Newline-delimited list of metadata for an image
tags String Newline-delimited list of tags required
pull Bool false Always attempt to pull a newer version of the image
target String Sets the target stage to build
no-cache Bool false Do not use cache when building the image
platforms String Comma-delimited list of target platforms for build
load Bool false Shorthand for --output=type=docker
push Bool false Shorthand for --output=type=registry
outputs String Newline-delimited list of output destinations (format: type=local,dest=path)
cache-from String Newline-delimited list of external cache sources (eg. user/app:cache, type=local,src=path/to/dir)
cache-to String Newline-delimited list of cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)

outputs

Following outputs are available

Name Type Description
digest String Image content-addressable identifier also called a digest

Limitation

This action is only available for Linux virtual environments.