Tests (pytest + coverage) workflow (kaifcodec/user-scanner)

The Tests (pytest + coverage) workflow from kaifcodec/user-scanner, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: kaifcodec/user-scanner.github/workflows/tests-pr.ymlLicense MITView source

What it does

This is the Tests (pytest + coverage) workflow from the kaifcodec/user-scanner 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

workflow (.yml)

name: Tests (pytest + coverage)

on:
  pull_request:

permissions:
  contents: read

jobs:
  test:
    name: Test (pytest + coverage) - ${{ matrix.python-version }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10"]

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}

      - name: Show Python info
        run: |
          python --version
          which python
          python -m pip --version

      - name: Cache pip
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml', '**/requirements*.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - name: Install package & test deps
        run: |
          python -m pip install --upgrade pip
          pip install .
          pip install pytest pytest-cov pytest-anyio anyio[trio]

      - name: Show installed packages
        run: pip freeze | sed -n '1,200p'

      - name: Run pytest with coverage
        run: |
          mkdir -p test-output
          pytest -vv --maxfail=1 \
            --junitxml=test-output/report.xml \
            --cov=user_scanner \
            --cov-report=xml:test-output/coverage.xml \
            --cov-report=term

      - name: Upload test artifacts
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: test-reports-${{ matrix.python-version }}
          path: test-output

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: Tests (pytest + coverage)
 
on:
  pull_request:
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    name: Test (pytest + coverage) - ${{ matrix.python-version }}
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: ["3.10"]
 
    steps:
      - name: Checkout
        uses: actions/checkout@v4
 
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Show Python info
        run: |
          python --version
          which python
          python -m pip --version
 
      - name: Cache pip
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml', '**/requirements*.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-
 
      - name: Install package & test deps
        run: |
          python -m pip install --upgrade pip
          pip install .
          pip install pytest pytest-cov pytest-anyio anyio[trio]
 
      - name: Show installed packages
        run: pip freeze | sed -n '1,200p'
 
      - name: Run pytest with coverage
        run: |
          mkdir -p test-output
          pytest -vv --maxfail=1 \
            --junitxml=test-output/report.xml \
            --cov=user_scanner \
            --cov-report=xml:test-output/coverage.xml \
            --cov-report=term
 
      - name: Upload test artifacts
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: test-reports-${{ matrix.python-version }}
          path: test-output

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

actions/checkout actions/setup-python actions/cache actions/upload-artifact