GitHub Action to build and push Docker images with Buildx
Find a file
CrazyMax 38c1f188ca
Add digest output
Fix platforms and allow inputs

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-08-17 22:18:37 +02:00
.github/workflows Add digest output 2020-08-17 22:18:37 +02:00
__tests__ Add digest output 2020-08-17 22:18:37 +02:00
dist Add digest output 2020-08-17 22:18:37 +02:00
setup-buildx Fix package name 2020-08-17 02:28:28 +02:00
setup-qemu Fix and cleanup of v2 setup actions 2020-08-16 04:14:43 +02:00
src Add digest output 2020-08-17 22:18:37 +02:00
test Remove bake support for now (future release or subaction) 2020-08-17 18:26:46 +02:00
.editorconfig Move editorconfig 2020-08-11 21:05:57 +02:00
.gitattributes Build push action v2 2020-08-16 00:36:41 +02:00
.gitignore Build push action v2 2020-08-16 00:36:41 +02:00
.prettierrc.json Build push action v2 2020-08-16 00:36:41 +02:00
action.yml Add digest output 2020-08-17 22:18:37 +02:00
jest.config.js Ignore subactions 2020-08-17 02:47:12 +02:00
LICENSE Rename LICENCE to LICENSE 2020-03-17 18:43:10 -07:00
package.json Remove GitHub Cache support for now (future release or buildkit cache provider?) 2020-08-17 18:35:15 +02:00
README.md Add digest output 2020-08-17 22:18:37 +02:00
tsconfig.json Build push action v2 2020-08-16 00:36:41 +02:00
yarn.lock Remove GitHub Cache support for now (future release or buildkit cache provider?) 2020-08-17 18:35:15 +02:00

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:
  main:
    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
      -
        name: Login to DockerHub
        uses: crazy-max/ghaction-docker-login@v1 # switch to docker/login-action@v1 when available 
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}
      -
        name: Build and push
        id: docker_build
        uses: docker/build-push-action@v2
        with:
          builder: ${{ steps.buildx.outputs.name }}
          push: true
          tags: |
            user/app:latest
            user/app:1.0.0            
      -
        name: Image digest
        run: echo ${{ steps.docker_build.outputs.digest }}

Multi-platform image

name: ci

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

jobs:
  multi:
    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
      -
        name: Login to DockerHub
        uses: crazy-max/ghaction-docker-login@v1 # switch to docker/login-action@v1 when available 
        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 }}
          push: true
          tags: |
            user/app:latest
            user/app:1.0.0            

Git context

You can build from Git directly without actions/checkout action, even in private repositories if your context is a valid Git url:

name: ci

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

jobs:
  git-context:
    runs-on: ubuntu-latest
    steps:
      -
        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: Login to DockerHub
        uses: crazy-max/ghaction-docker-login@v1 # switch to docker/login-action@v1 when available
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}
      -
        name: Build and push
        uses: ./
        env:
          GIT_AUTH_TOKEN: ${{ github.token }}
        with:
          context: "${{ github.repositoryUrl }}#${{ github.ref }}"
          builder: ${{ steps.buildx.outputs.name }}
          platforms: linux/amd64,linux/arm64,linux/386
          push: true
          tags: |
            name/app:latest
            name/app:1.0.0            

Customizing

inputs

Following inputs can be used as step.with keys

Name Type Default Description
builder String Builder instance (see setup-buildx action)
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 List List of build-time variables
labels List List of metadata for an image
tags List List of tags
pull Bool false Always attempt to pull a newer version of the image
target String Sets the target stage to build
allow List List of extra privileged entitlement (eg. network.host,security.insecure)
no-cache Bool false Do not use cache when building the image
platforms List List of target platforms for build
load Bool false Load is a shorthand for --output=type=docker
push Bool false Push is a shorthand for --output=type=registry
outputs List List of output destinations (format: type=local,dest=path)
cache-from List List of external cache sources (eg. user/app:cache, type=local,src=path/to/dir)
cache-to List List of cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)

List type can be a comma or newline-delimited string

tags: name/app:latest,name/app:1.0.0
tags: |
  name/app:latest
  name/app:1.0.0  

outputs

Following outputs are available

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

environment variables

Following environment variables can be used as step.env keys

Name Description
GIT_AUTH_HEADER¹ Raw authorization header to authenticate against git repository
GIT_AUTH_TOKEN¹ x-access-token basic auth to authenticate against git repository

¹ Only used if input.context is a valid git uri.

Limitation

This action is only available for Linux virtual environments.