Python package release workflow (cwendt94/espn-api)
The Python package release workflow from cwendt94/espn-api, explained and optimized by Latchkey.
CI health: C - fair
Point runs-on at Latchkey and get caching, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Python package release workflow from the cwendt94/espn-api 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: Python package release
on:
release:
types: [created]
jobs:
release:
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/espn-api
permissions:
id-token: write
steps:
- uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v3
with:
python-version: "3.8"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install twine
pip install wheel
- name: Build Python package
run: python setup.py bdist_wheel
- name: Twine check
run: twine check dist/*
- name: Publish to PyPI
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: Python package release on: release: types: [created] jobs: release: timeout-minutes: 30 runs-on: latchkey-small environment: name: pypi url: https://pypi.org/p/espn-api permissions: id-token: write steps: - uses: actions/checkout@v3 - name: Setup Python uses: actions/setup-python@v3 with: cache: 'pip' python-version: "3.8" - name: Install dependencies run: | python -m pip install --upgrade pip pip install twine pip install wheel - name: Build Python package run: python setup.py bdist_wheel - name: Twine check run: twine check dist/* - name: Publish to PyPI uses: pypa/gh-action-pypi-publish@release/v1
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 useslatchkey-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.