Publish snapshot workflow (allegro/ralph)

The Publish snapshot workflow from allegro/ralph, explained and optimized by Latchkey.

What it does

This is the Publish snapshot workflow from the allegro/ralph repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

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

The workflow

name: Publish snapshot

on:
  workflow_dispatch:
    inputs:
      branch:
        description: 'For which branch build snapshot?'
        required: true

jobs:
  publish:

    runs-on: ubuntu-latest
    environment: ci

    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
          ref: ${{ github.event.inputs.branch }}
      - name: Publish docker snapshot
        env:
          RETRY_COUNT: 3
        run: |
          docker login --username ${{ secrets.DOCKER_HUB_USERNAME }} --password ${{ secrets.DOCKER_HUB_PASSWORD }}
          export RALPH_VERSION=$(shell ./get_version.sh show)
          until [ "$RETRY_COUNT" -le 0 ]
            do
              make publish-docker-snapshot-image && break
              RETRY_COUNT=$((RETRY_COUNT-1))
              echo "==== Publish docker failed. Remaining retries: $RETRY_COUNT ===="
            done
          docker logout

The same workflow, on Latchkey

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

name: Publish snapshot
 
on:
  workflow_dispatch:
    inputs:
      branch:
        description: 'For which branch build snapshot?'
        required: true
 
jobs:
  publish:
    timeout-minutes: 30
 
    runs-on: latchkey-small
    environment: ci
 
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
          ref: ${{ github.event.inputs.branch }}
      - name: Publish docker snapshot
        env:
          RETRY_COUNT: 3
        run: |
          docker login --username ${{ secrets.DOCKER_HUB_USERNAME }} --password ${{ secrets.DOCKER_HUB_PASSWORD }}
          export RALPH_VERSION=$(shell ./get_version.sh show)
          until [ "$RETRY_COUNT" -le 0 ]
            do
              make publish-docker-snapshot-image && break
              RETRY_COUNT=$((RETRY_COUNT-1))
              echo "==== Publish docker failed. Remaining retries: $RETRY_COUNT ===="
            done
          docker logout
 

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.
• Add a job timeout so a hung step cannot burn hours of runner time.

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