Package and publish container image workflow (statsd/statsd)

The Package and publish container image workflow from statsd/statsd, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: statsd/statsd.github/workflows/package-and-publish-image.ymlLicense MITView source

What it does

This is the Package and publish container image workflow from the statsd/statsd repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

# Build, package, and publish a container image to our supported
# image registries. We generate a number of tags in different scenarios.
#
# * Commit pushed on default branch: publish with semver and "latest" tags.
# * Tag on default branch pushed: publish with short commit sha and "edge" tags.
#
# We currently publish to dockerhub and ghcr.

name: Package and publish container image

on:
  push:
    branches:
      - master
    tags:
      - "v*"

jobs:
  publish:
    name: Build and publish image
    runs-on: ubuntu-22.04
    steps:
      - name: Generate container image meta tags
        id: meta
        uses: docker/metadata-action@v4
        with:
          images: |
            statsd/statsd
            ghcr.io/statsd/statsd
          flavor: |
            latest=true
          tags: |
            type=semver,pattern=v{{version}},event=tag
            type=semver,pattern=v{{major}}.{{minor}},event=tag
            type=semver,pattern=v{{major}},event=tag
            type=edge,branch=$repo.default_branch,event=push
            type=sha,branch=$repo.default_branch,event=push

      - name: Setup buildx
        uses: docker/setup-buildx-action@v1

      - name: Login to DockerHub container registry
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Login to GitHub container registry
        uses: docker/login-action@v2
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ github.token }}

      - name: Build and publish image
        id: docker_build
        uses: docker/build-push-action@v4
        with:
          push: true
          platforms: linux/amd64,linux/s390x,linux/arm64
          tags: ${{ steps.meta.outputs.tags }}

      - name: Echo image digest
        run: echo ${{ steps.docker_build.outputs.digest }}

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

# Build, package, and publish a container image to our supported
# image registries. We generate a number of tags in different scenarios.
#
# * Commit pushed on default branch: publish with semver and "latest" tags.
# * Tag on default branch pushed: publish with short commit sha and "edge" tags.
#
# We currently publish to dockerhub and ghcr.
 
name: Package and publish container image
 
on:
  push:
    branches:
      - master
    tags:
      - "v*"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  publish:
    timeout-minutes: 30
    name: Build and publish image
    runs-on: latchkey-small
    steps:
      - name: Generate container image meta tags
        id: meta
        uses: docker/metadata-action@v4
        with:
          images: |
            statsd/statsd
            ghcr.io/statsd/statsd
          flavor: |
            latest=true
          tags: |
            type=semver,pattern=v{{version}},event=tag
            type=semver,pattern=v{{major}}.{{minor}},event=tag
            type=semver,pattern=v{{major}},event=tag
            type=edge,branch=$repo.default_branch,event=push
            type=sha,branch=$repo.default_branch,event=push
 
      - name: Setup buildx
        uses: docker/setup-buildx-action@v1
 
      - name: Login to DockerHub container registry
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
 
      - name: Login to GitHub container registry
        uses: docker/login-action@v2
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ github.token }}
 
      - name: Build and publish image
        id: docker_build
        uses: docker/build-push-action@v4
        with:
          push: true
          platforms: linux/amd64,linux/s390x,linux/arm64
          tags: ${{ steps.meta.outputs.tags }}
 
      - name: Echo image digest
        run: echo ${{ steps.docker_build.outputs.digest }}

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Cancel superseded runs when a branch or PR gets a newer push.
Add a job timeout so a hung step cannot burn hours of runner time.

4 third-party actions are referenced by a movable tag. Pin them to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

Container pulls and builds

This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

docker/metadata-action docker/setup-buildx-action docker/login-action docker/build-push-action