github-action-docker-buildx-build

Synopsis

A GitHub Action for invoking docker buildx build.

Overview

The GitHub Action performs:

1. docker/setup-qemu-action@v3
2. docker/setup-buildx-action@v3
3. docker/login-action@v3
   Logs into a Docker registry (docker.io being the default)
4. Performs docker buildx build...

Usage

1. An example .github/workflows/docker-build-container.yaml file which verifies that the Docker image builds successfully:

   name: docker-build-container.yaml
   
   on: [push]
   
   jobs:
       docker-build-container:
           runs-on: ubuntu-latest
           steps:
           - name: Build docker image
             uses: Senzing/github-action-docker-buildx-build@latest
             with:
                 image-repository: senzing/test-ground
                 image-tag: ${{ github.ref_name }}
                 password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
                 username: ${{ secrets.DOCKERHUB_USERNAME }}

2. An example .github/workflows/docker-push-container-to-dockerhub.yaml file which builds Docker images and pushes them to DockerHub:

   name: docker-push-container-to-dockerhub.yaml
   
   on:
       push:
           tags:
           - "[0-9]+.[0-9]+.[0-9]+"
   
   jobs:
       docker-push-containers-to-dockerhub:
           runs-on: ubuntu-latest
           steps:
           - name: Build docker image and push to DockerHub
             uses: Senzing/github-action-docker-buildx-build@latest
             with:
                 build-options: "--push"
                 image-repository: senzing/test-ground
                 image-tag: ${{ github.ref_name }}
                 password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
                 username: ${{ secrets.DOCKERHUB_USERNAME }}

   Notice the addition of the --push build option. Build options are inserted into the docker buildx build command.

Inputs

See also inputs: section of action.yaml

build-options

Command-line arguments passed directly to docker buildx build

• Optional parameter
• Default: "" (no build options)

context

The docker command's build context. See Description.

• Optional parameter
• Default: "."

image-repository

The identifier of the Docker image.

• Required parameter
• Example: senzing/senzingapi-runtime

image-tag

The tag appended to the Docker image identifier. Example: the 1.2.3 in senzing/senzingapi-runtime:1.2.3

• Optional parameter
• Default: "latest"

password

The access token or password for the user on the Docker registry server.
It is recommended to use an access token for login.
Refer to the respective registry provider documentation for additional login details.

• Required parameter

platforms

The comma-separated list of platforms to build on. To find candidates, run docker buildx ls

• Optional parameter
• Default: "linux/amd64"

registry-server

The Docker registry server.

• Optional parameter
• Default: docker.io

username

The username on the Docker registry server.

• Required parameter