[GitHub Action] Use GitHub Action build push action v2 to build and push docker image

Posted on 2022-03-12 Edited on 2024-09-12 In GitHub , GitHub Action , build-push-action Views: Word count in article: 3.7k Reading time ≈ 3 mins.

GitHub Action build-push-action V2

build-push-action is a GitHub Action to build and push Docker images with Buildx with full support of the features provided by Moby BuildKit builder toolkit. This includes multi-platform build, secrets, remote cache, etc. and different builder deployment/namespacing options.

Basic usage

name: ci

on:
  push:
    branches:
      - 'main'

jobs:
  docker:
    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: .
          push: true
          tags: user/app:latest

Advanced usage

Multi-platform image

You can build multi-platform images using the platforms input as described below.

💡 List of available platforms will be displayed and available through our setup-buildx - https://github.com/docker/setup-buildx-action#about action.

💡 If you want support for more platforms, you can use QEMU with our setup-qemu - https://github.com/docker/setup-qemu-action action.

      -
        name: Build and push
        uses: docker/build-push-action@v2
        with:
          context: .
+           platforms: linux/amd64,linux/arm64
          push: true
          tags: user/app:latest

See build-push-action/multi-platform.md at master · docker/build-push-action - https://github.com/docker/build-push-action/blob/master/docs/advanced/multi-platform.md to learn more.

Handle tags and labels

If you want an “automatic” tag management and OCI Image Format Specification for labels, you can do it in a dedicated step. The following workflow will use the Docker metadata action to handle tags and labels based on GitHub actions events and Git metadata.


jobs:
  docker:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
+       -
+         name: Docker meta
+         id: meta
+         uses: docker/metadata-action@v3
+         with:
+           # list of Docker images to use as base name for tags
+           images: |
+             name/app
+           # generate Docker tags based on the following events/attributes
+           tags: |
+             type=schedule
+             type=ref,event=branch
+             type=ref,event=pr
+             type=semver,pattern={{version}}
+             type=semver,pattern={{major}}.{{minor}}
+             type=semver,pattern={{major}}
+             type=sha
      -
        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
        uses: docker/build-push-action@v2
        with:
          context: .
          push: ${{ github.event_name != 'pull_request' }}
+           tags: ${{ steps.meta.outputs.tags }}
+           labels: ${{ steps.meta.outputs.labels }}