Publish Python 🐍 Distribution 📦 to PyPI and TestPyPI workflow (mstuttgart/brazilcep)

The Publish Python 🐍 Distribution 📦 to PyPI and TestPyPI workflow from mstuttgart/brazilcep, explained and optimized by Latchkey.

What it does

This is the Publish Python 🐍 Distribution 📦 to PyPI and TestPyPI workflow from the mstuttgart/brazilcep 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 Python 🐍 Distribution 📦 to PyPI and TestPyPI

on:
  push:
    branches:
      - main
    tags:
      - "*"

jobs:
  build:
    name: Build Distribution 📦
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Set Up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.*"

      - name: Install Build Dependencies
        run: pip install ".[build]"

      - name: Build Distribution Packages
        run: python3 -m build

      - name: Upload Distribution Packages
        uses: actions/upload-artifact@v4
        with:
          name: python-package-distributions
          path: dist/

  publish-to-pypi:
    name: Publish Distribution 📦 to PyPI
    if: startsWith(github.ref, 'refs/tags/') # Only publish on tag pushes
    needs: build
    runs-on: ubuntu-latest

    environment:
      name: pypi
      url: https://pypi.org/p/brazilcep

    permissions:
      id-token: write

    steps:
      - name: Download Distribution Packages
        uses: actions/download-artifact@v4
        with:
          name: python-package-distributions
          path: dist/

      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1

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 Python 🐍 Distribution 📦 to PyPI and TestPyPI
 
on:
  push:
    branches:
      - main
    tags:
      - "*"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    name: Build Distribution 📦
    runs-on: latchkey-small
 
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
 
      - name: Set Up Python
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: "3.*"
 
      - name: Install Build Dependencies
        run: pip install ".[build]"
 
      - name: Build Distribution Packages
        run: python3 -m build
 
      - name: Upload Distribution Packages
        uses: actions/upload-artifact@v4
        with:
          name: python-package-distributions
          path: dist/
 
  publish-to-pypi:
    timeout-minutes: 30
    name: Publish Distribution 📦 to PyPI
    if: startsWith(github.ref, 'refs/tags/') # Only publish on tag pushes
    needs: build
    runs-on: latchkey-small
 
    environment:
      name: pypi
      url: https://pypi.org/p/brazilcep
 
    permissions:
      id-token: write
 
    steps:
      - name: Download Distribution Packages
        uses: actions/download-artifact@v4
        with:
          name: python-package-distributions
          path: dist/
 
      - name: Publish to PyPI
        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.
• 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.

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 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