wdzeng / image

A GitHub action to build and push image onto dockerhub

Image Action

A GitHub action to build and push image to Docker Hub and GitHub Container Registry (ghcr).

For stable releases, four tags are pushed: X.X.X, X.X, X, and latest; for pre-releases, two tags are pushed: the project version and edge.

If variant name is specified, a variant- prefix is added for tags, while tag latest is replaced with variant name. For example, if variant name is kelly and version is 1.2.3, then tags are kelly-1.2.3, kelly-1.2, kelly-1, and kelly. Or if version is 1.2.3-alpha.1 then kelly-1.2.3-alpha.1 and kelly-edge.

Prerequisites

• Dockerfile is placed at repository root location.

Usage

Following example shows how to build project and build and push images to Docker Hub and GitHub Container Registry.

jobs:
  build:
    name: Build project and push image onto dockerhub
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Build project
        run: yarn install --frozen-lockfile && yarn build
      - uses: wdzeng/image@v2
        with:
          dockerhub-username: your-dockerhub-username
          dockerhub-password: ${{ secrets.DOCKERHUB_TOKEN }}

Inputs

Unless otherwise noted with a default value, each input is required.

• github-token: token used to push image onto ghcr; required only if the repository has no write permission to ghcr.
• dockerhub-username: dockerhub username; optional if you are not pushing to dockerhub; default to github username
• dockerhub-password: dockerhub token; optional if you are not pushing to dockerhub
• image: image name; default to repository name
• variant: image variant; default to none
• dockerhub: whether to push image to Docker Hub; default to true
• init: whether to setup QEMU and buildx; set to false if this is not the first time the action is used; default to true
• platforms: platforms to build images; default to linux/amd64,linux/arm64,linux/arm/v7
• build-target: build target; optional
• build-args: build arguments; one line per argument; optional
• repo-description: repository description which will be added to image labels
• repo-license: repository license which will be added to image labels

You may need to set github-token for the first time the image is pushed to ghcr since it is tricky to give write permission to the repository.