Publish workflow (rsagroup/rsatoolbox)

The Publish workflow from rsagroup/rsatoolbox, explained and optimized by Latchkey.

What it does

This is the Publish workflow from the rsagroup/rsatoolbox 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

on:
  push:
    branches:
      - main
  release:
     types: [published]

permissions:
  contents: read
  id-token: write

jobs:
  call-test-build:
    uses: ./.github/workflows/testbuild.yml

  publish-artifacts:
    environment: production
    needs: call-test-build
    runs-on: ubuntu-latest
    steps:
      - name: Download all wheels
        uses: actions/download-artifact@v7
        with:
          pattern: wheels-*
          path: dist
          merge-multiple: true
      ## Download only a single source file as merging may cause corruption
      - name: Download source tarball
        uses: actions/download-artifact@v7
        with:
          name: source-ubuntu-latest-3.14
          path: dist
      - name: List files
        run: ls -R dist
      - name: Test source package for corruption
        run: gzip -t dist/*.tar.gz
      - name: Publish package
        uses: pypa/gh-action-pypi-publish@v1.13.0
        with:
          verbose: true

The same workflow, on Latchkey

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

name: Publish
 
on:
  push:
    branches:
      - main
  release:
     types: [published]
 
permissions:
  contents: read
  id-token: write
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  call-test-build:
    timeout-minutes: 30
    uses: ./.github/workflows/testbuild.yml
 
  publish-artifacts:
    timeout-minutes: 30
    environment: production
    needs: call-test-build
    runs-on: latchkey-small
    steps:
      - name: Download all wheels
        uses: actions/download-artifact@v7
        with:
          pattern: wheels-*
          path: dist
          merge-multiple: true
      ## Download only a single source file as merging may cause corruption
      - name: Download source tarball
        uses: actions/download-artifact@v7
        with:
          name: source-ubuntu-latest-3.14
          path: dist
      - name: List files
        run: ls -R dist
      - name: Test source package for corruption
        run: gzip -t dist/*.tar.gz
      - name: Publish package
        uses: pypa/gh-action-pypi-publish@v1.13.0
        with:
          verbose: true
 

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.

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

Actions used in this workflow