Release workflow (abey79/vpype)

The Release workflow from abey79/vpype, explained and optimized by Latchkey.

What it does

This is the Release workflow from the abey79/vpype 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: Release

on:
  push:
    tags:
      - '*.*.*'

jobs:
  # ----------------------------------------
  pypi-upload:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install poetry
        run: pipx install --python 3.12 poetry!=1.4.1

      - name: Build artifacts
        run: poetry build

      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          # repository_url: https://test.pypi.org/legacy/
          # password: ${{ secrets.TEST_PYPI_TOKEN }}
          password: ${{ secrets.PYPI_TOKEN }}
          verbose: true

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

name: Release
 
on:
  push:
    tags:
      - '*.*.*'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  # ----------------------------------------
  pypi-upload:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
 
      - name: Install Python
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: '3.12'
 
      - name: Install poetry
        run: pipx install --python 3.12 poetry!=1.4.1
 
      - name: Build artifacts
        run: poetry build
 
      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          # repository_url: https://test.pypi.org/legacy/
          # password: ${{ secrets.TEST_PYPI_TOKEN }}
          password: ${{ secrets.PYPI_TOKEN }}
          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.
• Cache dependency installs on the setup step so they are served from cache.
• 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 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