Publish Python 🐍 distributions 📦 to PyPI workflow (ishepard/pydriller)

The Publish Python 🐍 distributions 📦 to PyPI workflow from ishepard/pydriller, explained and optimized by Latchkey.

What it does

This is the Publish Python 🐍 distributions 📦 to PyPI workflow from the ishepard/pydriller 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: Publish Python 🐍 distributions 📦 to PyPI
on:
  push:
    tags:        
      - 2*

jobs:
  publish:
    name: "Build, test and upload to pypi"
    runs-on: "ubuntu-latest"
    environment:
      name: pypi
      url: https://pypi.org/project/PyDriller/
    permissions:
      id-token: write

    steps:
      - uses: actions/checkout@v3
      - name: Install python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11' 
      - name: Install dependencies and unzip test-repos
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install -r test-requirements.txt
          pip install pytest-cov
          unzip test-repos
      - name: Mypy
        run: |
          pip install mypy
          mypy --ignore-missing-imports pydriller/ tests/
      - name: Lint with flake8
        run: |
          pip install flake8
          flake8
      - name: Run pytest
        run: pytest tests/ --cov=pydriller/ --cov-report=xml
      - name: Build app
        run: |
          pip install wheel 
          python setup.py bdist_wheel
      - name: Publish distribution 📦 to PyPI
        if: startsWith(github.ref, 'refs/tags')
        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 🐍 distributions 📦 to PyPI
on:
  push:
    tags:        
      - 2*
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  publish:
    timeout-minutes: 30
    name: "Build, test and upload to pypi"
    runs-on: "ubuntu-latest"
    environment:
      name: pypi
      url: https://pypi.org/project/PyDriller/
    permissions:
      id-token: write
 
    steps:
      - uses: actions/checkout@v3
      - name: Install python
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: '3.11' 
      - name: Install dependencies and unzip test-repos
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install -r test-requirements.txt
          pip install pytest-cov
          unzip test-repos
      - name: Mypy
        run: |
          pip install mypy
          mypy --ignore-missing-imports pydriller/ tests/
      - name: Lint with flake8
        run: |
          pip install flake8
          flake8
      - name: Run pytest
        run: pytest tests/ --cov=pydriller/ --cov-report=xml
      - name: Build app
        run: |
          pip install wheel 
          python setup.py bdist_wheel
      - name: Publish distribution 📦 to PyPI
        if: startsWith(github.ref, 'refs/tags')
        uses: pypa/gh-action-pypi-publish@release/v1
 

What changed

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