code-coverage workflow (swansonk14/p_tqdm)

The code-coverage workflow from swansonk14/p_tqdm, explained and optimized by Latchkey.

What it does

This is the code-coverage workflow from the swansonk14/p_tqdm 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: code-coverage
on:
  push:
    branches: [ main ]
jobs:
  run:
    runs-on: ubuntu-latest
    env:
      PYTHON: '3.12'
    steps:
    - uses: actions/checkout@main
    - name: Setup Python
      uses: actions/setup-python@main
      with:
        python-version: '3.12'
    - name: Generate coverage report
      run: |
        git config --global user.email "you@example.com"
        git config --global user.name "Your Name"
        python -m pip install --upgrade pip
        python -m pip install -e .
        python -m pip install -e .
        python -m pip install pytest
        python -m pip install pytest-cov
        pytest --cov=p_tqdm --cov-report=xml
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v1
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        files: ./coverage.xml
        flags: unittests
        env_vars: OS,PYTHON
        name: codecov-umbrella
        verbose: true

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: code-coverage
on:
  push:
    branches: [ main ]
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  run:
    timeout-minutes: 30
    runs-on: latchkey-small
    env:
      PYTHON: '3.12'
    steps:
    - uses: actions/checkout@main
    - name: Setup Python
      uses: actions/setup-python@main
      with:
        cache: 'pip'
        python-version: '3.12'
    - name: Generate coverage report
      run: |
        git config --global user.email "you@example.com"
        git config --global user.name "Your Name"
        python -m pip install --upgrade pip
        python -m pip install -e .
        python -m pip install -e .
        python -m pip install pytest
        python -m pip install pytest-cov
        pytest --cov=p_tqdm --cov-report=xml
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v1
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        files: ./coverage.xml
        flags: unittests
        env_vars: OS,PYTHON
        name: codecov-umbrella
        verbose: true
 

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