Publish to PyPI workflow (sgl-project/SpecForge)

The Publish to PyPI workflow from sgl-project/SpecForge, explained and optimized by Latchkey.

What it does

This is the Publish to PyPI workflow from the sgl-project/SpecForge 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 to PyPI

on:
  workflow_dispatch:

jobs:
  build-n-publish:
    if: github.event_name == 'workflow_dispatch'
    name: Build and publish Python distributions to PyPI
    runs-on: ubuntu-latest
    timeout-minutes: 20
    environment:
      name: pypi
      url: https://pypi.org/p/specforgeee
    permissions:
      id-token: write
    steps:
    - uses: actions/checkout@v2

    - uses: actions/setup-python@v2
      with:
        python-version: '3.11'

    - run: pip install build && python -m build --sdist

    # publish to PyPI if executed on the main branch
    - name: Publish package to PyPI
      id: publish
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        user: __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: Publish to PyPI
 
on:
  workflow_dispatch:
 
jobs:
  build-n-publish:
    if: github.event_name == 'workflow_dispatch'
    name: Build and publish Python distributions to PyPI
    runs-on: latchkey-small
    timeout-minutes: 20
    environment:
      name: pypi
      url: https://pypi.org/p/specforgeee
    permissions:
      id-token: write
    steps:
    - uses: actions/checkout@v2
 
    - uses: actions/setup-python@v2
      with:
        cache: 'pip'
        python-version: '3.11'
 
    - run: pip install build && python -m build --sdist
 
    # publish to PyPI if executed on the main branch
    - name: Publish package to PyPI
      id: publish
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        user: __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.
• Cache dependency installs on the setup step so they are served from cache.

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:

• Dependency installs

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