Publish Python 🐍 distributions 📦 to PyPI and TestPyPI workflow (alibaba/tidevice)

The Publish Python 🐍 distributions 📦 to PyPI and TestPyPI workflow from alibaba/tidevice, explained and optimized by Latchkey.

What it does

This is the Publish Python 🐍 distributions 📦 to PyPI and TestPyPI workflow from the alibaba/tidevice 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

# Ref
# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI

on:
  push:
    tags:
      - '*.*.*'

jobs:
  Release:
    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
        with:
          fetch-depth: 5

      - name: Set up Python 3.9
        uses: actions/setup-python@v1
        with:
          python-version: 3.9

      - name: Install pypa/build
        run: |
          python -m pip install --upgrade pip
          pip install flake8 pytest wheel coverage
          python3 -m pip install -e .

      - name: Run coverage
        run: |
          coverage run -m pytest -v tests/
          coverage xml
          coverage report

      - name: Build targz and wheel
        run: |
          python3 setup.py sdist bdist_wheel
          
      - name: Publish distribution 📦 to PyPI
        if: startsWith(github.ref, 'refs/tags')
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          skip-existing: true
          password: ${{ secrets.PYPI_API_TOKEN }}

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.

# Ref
# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
 
on:
  push:
    tags:
      - '*.*.*'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  Release:
    timeout-minutes: 30
    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@master
        with:
          fetch-depth: 5
 
      - name: Set up Python 3.9
        uses: actions/setup-python@v1
        with:
          cache: 'pip'
          python-version: 3.9
 
      - name: Install pypa/build
        run: |
          python -m pip install --upgrade pip
          pip install flake8 pytest wheel coverage
          python3 -m pip install -e .
 
      - name: Run coverage
        run: |
          coverage run -m pytest -v tests/
          coverage xml
          coverage report
 
      - name: Build targz and wheel
        run: |
          python3 setup.py sdist bdist_wheel
          
      - name: Publish distribution 📦 to PyPI
        if: startsWith(github.ref, 'refs/tags')
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          skip-existing: true
          password: ${{ secrets.PYPI_API_TOKEN }}
 

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.

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