Publish API image workflow (engineer-man/piston)

The Publish API image workflow from engineer-man/piston, explained and optimized by Latchkey.

What it does

This is the Publish API image workflow from the engineer-man/piston 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

name: Publish API image
on:
    push:
        branches:
            - master
            - v3
        paths:
            - api/**

jobs:
    push_to_registry:
        runs-on: ubuntu-latest
        name: Build and Push Docker image to Github Packages
        steps:
            - name: Check out repo
              uses: actions/checkout@v3
            - name: Login to GitHub registry
              uses: docker/login-action@v2
              with:
                  username: ${{ github.actor }}
                  password: ${{ secrets.GITHUB_TOKEN }}
                  registry: docker.pkg.github.com
            - name: Login to ghcr.io
              uses: docker/login-action@v2
              with:
                  username: ${{ github.actor }}
                  password: ${{ secrets.GITHUB_TOKEN }}
                  registry: ghcr.io

            - name: Build and push API
              uses: docker/build-push-action@v4
              with:
                  context: api
                  push: true
                  pull: true
                  tags: |
                      docker.pkg.github.com/engineer-man/piston/api
                      ghcr.io/engineer-man/piston

The same workflow, on Latchkey

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

name: Publish API image
on:
    push:
        branches:
            - master
            - v3
        paths:
            - api/**
 
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true
 
jobs:
    push_to_registry:
        timeout-minutes: 30
        runs-on: latchkey-small
        name: Build and Push Docker image to Github Packages
        steps:
            - name: Check out repo
              uses: actions/checkout@v3
            - name: Login to GitHub registry
              uses: docker/login-action@v2
              with:
                  username: ${{ github.actor }}
                  password: ${{ secrets.GITHUB_TOKEN }}
                  registry: docker.pkg.github.com
            - name: Login to ghcr.io
              uses: docker/login-action@v2
              with:
                  username: ${{ github.actor }}
                  password: ${{ secrets.GITHUB_TOKEN }}
                  registry: ghcr.io
 
            - name: Build and push API
              uses: docker/build-push-action@v4
              with:
                  context: api
                  push: true
                  pull: true
                  tags: |
                      docker.pkg.github.com/engineer-man/piston/api
                      ghcr.io/engineer-man/piston
 

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.

2 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