Build and release package to PyPi workflow (Titan-Systems/titan)

The Build and release package to PyPi workflow from Titan-Systems/titan, explained and optimized by Latchkey.

What it does

This is the Build and release package to PyPi workflow from the Titan-Systems/titan repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

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

The workflow

name: Build and release package to PyPi

on:
  workflow_dispatch:
  workflow_call:
    secrets:
      PYPI_USERNAME:
        required: true
      PYPI_PASSWORD:
        required: true

jobs:
  build-and-release:
    runs-on: ubuntu-20.04
    steps:
      - name: actions/checkout
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.9'
      - name: Create a virtual environment
        run: |
          python -m venv .venv
      - name: Install dependencies
        run: |
          source ./.venv/bin/activate
          python -m pip install --upgrade pip
          make install-dev
      - name: Build and upload to PyPI
        run: |
          source ./.venv/bin/activate
          make submit
        env:
          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

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: Build and release package to PyPi
 
on:
  workflow_dispatch:
  workflow_call:
    secrets:
      PYPI_USERNAME:
        required: true
      PYPI_PASSWORD:
        required: true
 
jobs:
  build-and-release:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: actions/checkout
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: '3.9'
      - name: Create a virtual environment
        run: |
          python -m venv .venv
      - name: Install dependencies
        run: |
          source ./.venv/bin/activate
          python -m pip install --upgrade pip
          make install-dev
      - name: Build and upload to PyPI
        run: |
          source ./.venv/bin/activate
          make submit
        env:
          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

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