GitHub Release workflow (BayesWitnesses/m2cgen)

The GitHub Release workflow from BayesWitnesses/m2cgen, explained and optimized by Latchkey.

What it does

This is the GitHub Release workflow from the BayesWitnesses/m2cgen 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: GitHub Release

on:
  push:
    tags:
      - v*

jobs:
  release:
    name: Release
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
        with:
          fetch-depth: 5
      - name: Build Docker image
        run: docker build . --file Dockerfile -t m2cgen-docker
      - name: Build wheel file and source archive
        run: |
          docker run \
            -v "$GITHUB_WORKSPACE":"/m2cgen" \
            -e RELEASE="true" \
            m2cgen-docker \
            bash /m2cgen/.ci/test.sh
      - name: Create GitHub Release
        uses: softprops/action-gh-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          draft: true
          prerelease: false
          files: |
            ${{ github.workspace }}/dist/*.whl
            ${{ github.workspace }}/dist/*.tar.gz

The same workflow, on Latchkey

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

name: GitHub Release
 
on:
  push:
    tags:
      - v*
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  release:
    timeout-minutes: 30
    name: Release
    runs-on: latchkey-small
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
        with:
          fetch-depth: 5
      - name: Build Docker image
        run: docker build . --file Dockerfile -t m2cgen-docker
      - name: Build wheel file and source archive
        run: |
          docker run \
            -v "$GITHUB_WORKSPACE":"/m2cgen" \
            -e RELEASE="true" \
            m2cgen-docker \
            bash /m2cgen/.ci/test.sh
      - name: Create GitHub Release
        uses: softprops/action-gh-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          draft: true
          prerelease: false
          files: |
            ${{ github.workspace }}/dist/*.whl
            ${{ github.workspace }}/dist/*.tar.gz
 

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.

1 third-party action is referenced by a movable tag. Pin it 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