Publish to PyPI workflow (mwouts/itables)

The Publish to PyPI workflow from mwouts/itables, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: mwouts/itables.github/workflows/publish.ymlLicense MITView source

What it does

This is the Publish to PyPI workflow from the mwouts/itables 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

workflow (.yml)

name: Publish to PyPI
on:
  push:
    tags:
      - "v[0-9]+.[0-9]+.[0-9]+*"

jobs:
  publish:
    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/p/itables
    permissions:
      id-token: write
    steps:
      - name: Checkout source
        uses: actions/checkout@v6
      - name: Setup Pixi
        uses: prefix-dev/setup-pixi@v0.9.5
        with:
          pixi-version: latest
          locked: false
          frozen: true
          cache: true
      - name: Build package
        run: |
          # hatch==1.16.0 fails with
          # hatchling.plugin.exceptions.UnknownPluginError: Unknown build hook: jupyter-builder
          pixi run -e build hatch build
      - name: Publish
        uses: pypa/gh-action-pypi-publish@release/v1

The same workflow, on Latchkey

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

name: Publish to PyPI
on:
  push:
    tags:
      - "v[0-9]+.[0-9]+.[0-9]+*"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  publish:
    timeout-minutes: 30
    runs-on: latchkey-small
    environment:
      name: pypi
      url: https://pypi.org/p/itables
    permissions:
      id-token: write
    steps:
      - name: Checkout source
        uses: actions/checkout@v6
      - name: Setup Pixi
        uses: prefix-dev/setup-pixi@v0.9.5
        with:
          pixi-version: latest
          locked: false
          frozen: true
          cache: true
      - name: Build package
        run: |
          # hatch==1.16.0 fails with
          # hatchling.plugin.exceptions.UnknownPluginError: Unknown build hook: jupyter-builder
          pixi run -e build hatch build
      - name: Publish
        uses: pypa/gh-action-pypi-publish@release/v1

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.

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

actions/checkout