Publish to PyPI workflow (awesome-spectral-indices/spyndex)

The Publish to PyPI workflow from awesome-spectral-indices/spyndex, explained and optimized by Latchkey.

What it does

This is the Publish to PyPI workflow from the awesome-spectral-indices/spyndex 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:
  release:
    types: [published]  # triggers when a release is published

  workflow_dispatch:     # optional manual trigger


permissions:
  contents: read

  id-token: write   # REQUIRED for PyPI Trusted Publishing (OIDC)


jobs:
  build-and-publish:
    name: Build and publish to PyPI

    runs-on: ubuntu-latest

    # Only run if the release is NOT a prerelease

    if: github.event.release.prerelease == false


    steps:
      - name: Check out code

        uses: actions/checkout@v4


      - name: Set up Python

        uses: actions/setup-python@v5

        with:
          python-version: "3.11"


      - name: Install build tools

        run: |

          python -m pip install --upgrade pip

          python -m pip install build


      - name: Build sdist and wheel

        run: python -m build


      - name: Publish to PyPI (via OIDC)

        uses: pypa/gh-action-pypi-publish@release/v1

        with:
          print-hash: 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:

  release:

    types: [published]  # triggers when a release is published

  workflow_dispatch:     # optional manual trigger



permissions:

  contents: read

  id-token: write   # REQUIRED for PyPI Trusted Publishing (OIDC)



jobs:

  build-and-publish:

    timeout-minutes: 30

    name: Build and publish to PyPI

    runs-on: latchkey-small

    # Only run if the release is NOT a prerelease

    if: github.event.release.prerelease == false



    steps:

      - name: Check out code

        uses: actions/checkout@v4



      - name: Set up Python

        uses: actions/setup-python@v5

        with:

          cache: 'pip'

          python-version: "3.11"



      - name: Install build tools

        run: |

          python -m pip install --upgrade pip

          python -m pip install build



      - name: Build sdist and wheel

        run: python -m build



      - name: Publish to PyPI (via OIDC)

        uses: pypa/gh-action-pypi-publish@release/v1

        with:

          print-hash: 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.
• 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 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