Publish to PyPI workflow (anhvth/opensloth)

The Publish to PyPI workflow from anhvth/opensloth, explained and optimized by Latchkey.

What it does

This is the Publish to PyPI workflow from the anhvth/opensloth 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:
  push:
    branches:
      - master

jobs:
  publish:
    runs-on: ubuntu-latest
    if: startsWith(github.event.head_commit.message, 'Bump version')  # Add this line

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.x'

    - name: Install Poetry and Twine
      run: |
        python -m pip install --upgrade pip
        pip install poetry
        pip install twine  # Make sure twine is installed

    - name: Configure Git user
      run: |
        git config --global user.email "actions@github.com"
        git config --global user.name "GitHub Actions"

    - name: Build and publish package to PyPI
      env:
        TWINE_USERNAME: "__token__"
        PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
      run: |
        rm -rf dist/ build/ *.egg-info
        poetry build
        twine upload dist/* -p $PYPI_API_TOKEN --non-interactive

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:
  push:
    branches:
      - master
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  publish:
    timeout-minutes: 30
    runs-on: latchkey-small
    if: startsWith(github.event.head_commit.message, 'Bump version')  # Add this line
 
    steps:
    - name: Checkout code
      uses: actions/checkout@v2
 
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        cache: 'pip'
        python-version: '3.x'
 
    - name: Install Poetry and Twine
      run: |
        python -m pip install --upgrade pip
        pip install poetry
        pip install twine  # Make sure twine is installed
 
    - name: Configure Git user
      run: |
        git config --global user.email "actions@github.com"
        git config --global user.name "GitHub Actions"
 
    - name: Build and publish package to PyPI
      env:
        TWINE_USERNAME: "__token__"
        PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
      run: |
        rm -rf dist/ build/ *.egg-info
        poetry build
        twine upload dist/* -p $PYPI_API_TOKEN --non-interactive
 

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.

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