#
name: Create and publish a Docker image
# Configures this workflow to run every time a change is pushed to the branch called
# `main` or `dev`.
on:
push:
branches: ['main', 'dev']
tags: ['*']
# Defines two custom environment variables for the workflow. These are used for the
# Container registry domain, and a name for the Docker image that this workflow builds.
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
# There is a single job in this workflow. It's configured to run on the latest available
# version of Ubuntu.
jobs:
build-and-push-image:
runs-on: ubuntu-latest
# Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
permissions:
contents: read
packages: write
attestations: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v6
with:
submodules: true
# Uses the `docker/login-action` action to log in to the Container registry registry
# using the account and password that will publish the packages. Once published, the
# packages are scoped to the account defined here.
- name: Log in to the Container registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
# This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about)
# to extract tags and labels that will be applied to the specified image.
# The `id` "meta" allows the output of this step to be referenced in a subsequent
# step. The `images` value provides the base name for the tags and labels.
# It will automatically create the latest Docker tag, if a git tag is found: https://github.com/docker/metadata-action?tab=readme-ov-file#latest-tag
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
# This step gets the short git commit hash
# https://dev.to/hectorleiva/github-actions-and-creating-a-short-sha-hash-8b7
- name: Set short git commit SHA
id: vars
run: |
calculatedSha=$(git rev-parse --short ${{ github.sha }})
echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV
# This step uses the `docker/build-push-action` action to build the image, based on
# your repository's `Dockerfile`. If the build succeeds, it pushes the image to
# GitHub Packages.
# It uses the `context` parameter to define the build's context as the set of files
# located in the specified path. For more information, see [Usage](https://github.com/docker/build-push-action#usage)
# in the README of the `docker/build-push-action` repository.
# It uses the `tags` and `labels` parameters to tag and label the image with the
# output from the "meta" step.
- name: Build and push Docker image
id: push
uses: docker/build-push-action@v6
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
build-args: |
GIT_HASH=${{ github.sha }}
GIT_HASH_SHORT=${{ env.COMMIT_SHORT_SHA }}
# This step generates an artifact attestation for the image, which is an unforgeable
# statement about where and how it was built. It increases supply chain security for
# people who consume the image. For more information, see [Using artifact attestations
# to establish provenance for builds](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
- name: Generate artifact attestation
uses: actions/attest-build-provenance@v3
with:
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
subject-digest: ${{ steps.push.outputs.digest }}
push-to-registry: true
