Release Python Package to PyPi workflow (tfranzel/drf-spectacular)

The Release Python Package to PyPi workflow from tfranzel/drf-spectacular, explained and optimized by Latchkey.

What it does

This is the Release Python Package to PyPi workflow from the tfranzel/drf-spectacular repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

name: Release Python Package to PyPi

on: [ workflow_dispatch ]

jobs:
  publish:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v5
    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        python-version: '3.x'
    - name: Install dependencies
      run: |
        pip install -r requirements/packaging.txt
    - name: Build
      run: |
        python -m build
    - name: Publish
      env:
        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
      run: |
        twine upload dist/*
    - name: Tag
      run: |
        git config user.name github-actions
        git config user.email github-actions@github.com

        VERSION="$(cat drf_spectacular/__init__.py | grep "__version__" | cut -d"'" -f2)"

        git tag -a $VERSION -m 'version $VERSION'
        git push --tags

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.

# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
 
name: Release Python Package to PyPi
 
on: [ workflow_dispatch ]
 
jobs:
  publish:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v5
    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        cache: 'pip'
        python-version: '3.x'
    - name: Install dependencies
      run: |
        pip install -r requirements/packaging.txt
    - name: Build
      run: |
        python -m build
    - name: Publish
      env:
        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
      run: |
        twine upload dist/*
    - name: Tag
      run: |
        git config user.name github-actions
        git config user.email github-actions@github.com
 
        VERSION="$(cat drf_spectacular/__init__.py | grep "__version__" | cut -d"'" -f2)"
 
        git tag -a $VERSION -m 'version $VERSION'
        git push --tags

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.
• Add a job timeout so a hung step cannot burn hours of runner time.

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