Publish to PyPI workflow (openxla/tokamax)

The Publish to PyPI workflow from openxla/tokamax, explained and optimized by Latchkey.

CI health: A - excellent

Point runs-on at Latchkey and get caching, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: openxla/tokamax.github/workflows/publish.ymlLicense Apache-2.0View source

What it does

This is the Publish to PyPI workflow from the openxla/tokamax 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

workflow (.yml)

name: Publish to PyPI

on:
  # Event manually triggered (in the Github UI)
  workflow_dispatch:


# This job will publish the package to PyPI. It will use the release
# environment and OIDC tokens to publish the package via pypa-publish.
# See https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments
# and https://blog.pypi.org/posts/2023-04-20-introducing-trusted-publishers for more details.
jobs:
  pypi-publish:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    environment: release
    permissions:
      # IMPORTANT: this permission is mandatory for trusted publishing
      id-token: write
    defaults:
      run:
        shell: bash
    steps:
    - name: Checkout Tokamax
      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
      with:
        persist-credentials: false

    - name: Install Python 3.12
      uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c  # v6.0.0
      with:
        python-version: 3.12

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip --version
        python -m pip install build
        python -m pip install -e .[cuda,tpu,test]
        python -m pip freeze

    # Publish the package
    - name: Build Tokamax
      run: |
        python -m build

    - name: Publish package distributions to PyPI
      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc  # v1.12.4

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:
  # Event manually triggered (in the Github UI)
  workflow_dispatch:
 
 
# This job will publish the package to PyPI. It will use the release
# environment and OIDC tokens to publish the package via pypa-publish.
# See https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments
# and https://blog.pypi.org/posts/2023-04-20-introducing-trusted-publishers for more details.
jobs:
  pypi-publish:
    runs-on: latchkey-small
    timeout-minutes: 30
    environment: release
    permissions:
      # IMPORTANT: this permission is mandatory for trusted publishing
      id-token: write
    defaults:
      run:
        shell: bash
    steps:
    - name: Checkout Tokamax
      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
      with:
        persist-credentials: false
 
    - name: Install Python 3.12
      uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c  # v6.0.0
      with:
        cache: 'pip'
        python-version: 3.12
 
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip --version
        python -m pip install build
        python -m pip install -e .[cuda,tpu,test]
        python -m pip freeze
 
    # Publish the package
    - name: Build Tokamax
      run: |
        python -m build
 
    - name: Publish package distributions to PyPI
      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc  # v1.12.4

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.

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

actions/checkout actions/setup-python