Tests workflow (pdm-project/pdm)

The Tests workflow from pdm-project/pdm, 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.

Grade your own workflow free or run it on Latchkey →

Source: pdm-project/pdm.github/workflows/ci.ymlLicense MITView source

What it does

This is the Tests workflow from the pdm-project/pdm 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

on:
  pull_request:
    branches:
      - main
      - dev
      - "maintain/*"
    paths-ignore:
      - "docs/**"
      - "news/**"
      - "*.md"
  push:
    branches:
      - main
      - dev
      - "maintain/*"
    paths-ignore:
      - "docs/**"
      - "news/**"
      - "*.md"

concurrency:
  group: ${{ github.event.number || github.run_id }}
  cancel-in-progress: true

jobs:
  Testing:
    env:
      PYTHONDEVMODE: 1
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.10", 3.11, 3.12, 3.13, 3.14]
        os: [ubuntu-latest, windows-latest, macos-latest]
        install-via: [pip]
        include:
          - python-version: 3.12
            os: ubuntu-latest
            install-via: script
          - python-version: pypy-3.11
            os: ubuntu-latest
            install-via: pip
    steps:
      - uses: actions/checkout@v7.0.0

      - name: Setup Python Versions
        uses: actions/setup-python@v6
        with:
          python-version: |
            3.10
            3.11
            3.12
            3.13
            3.14
          allow-prereleases: true
        if: matrix.os != 'macos-latest'
      - name: Setup Python Versions
        uses: actions/setup-python@v6
        with:
          python-version: |
            3.10
            3.11
            3.12
            3.13
            3.14
          allow-prereleases: true
        if: matrix.os == 'macos-latest'
      - name: Setup Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
          allow-prereleases: true

      - name: Cache venv
        uses: actions/cache@v6.1.0
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('pdm.lock') }}
      - name: Install uv
        uses: astral-sh/setup-uv@v8.2.0
        with:
          version: "latest"
      - name: Install current PDM via pip
        if: matrix.install-via == 'pip'
        run: python -m pip install -U .
      - name: Install current PDM via script
        if: matrix.install-via == 'script'
        run: |
          shasum -a256 --check install-pdm.py.sha256
          python install-pdm.py --version head
          echo "$HOME/.local/bin" >> $GITHUB_PATH
      - name: Install Dev Dependencies
        run: |
          pdm install -v -Gtest
          pdm run pip install -U setuptools
          pdm info
      # - name: Setup tmate session
      #   uses: mxschmitt/action-tmate@v3.22
      - name: Run Tests
        run: pdm run pytest -n auto --cov=pdm --cov-config=pyproject.toml --cov-report=xml tests

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v7.0.0
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: ./coverage.xml
          flags: unittests

  Pack:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7.0.0
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v6
        with:
          python-version: 3.x
      - name: Install PDM
        run: |
          python -m pip install .
          pdm self add pdm-packer
      - name: Pack pdm
        run: pdm pack

      - name: Test zipapp
        run: python pdm.pyz --version

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
 
on:
  pull_request:
    branches:
      - main
      - dev
      - "maintain/*"
    paths-ignore:
      - "docs/**"
      - "news/**"
      - "*.md"
  push:
    branches:
      - main
      - dev
      - "maintain/*"
    paths-ignore:
      - "docs/**"
      - "news/**"
      - "*.md"
 
concurrency:
  group: ${{ github.event.number || github.run_id }}
  cancel-in-progress: true
 
jobs:
  Testing:
    timeout-minutes: 30
    env:
      PYTHONDEVMODE: 1
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.10", 3.11, 3.12, 3.13, 3.14]
        os: [ubuntu-latest, windows-latest, macos-latest]
        install-via: [pip]
        include:
          - python-version: 3.12
            os: ubuntu-latest
            install-via: script
          - python-version: pypy-3.11
            os: ubuntu-latest
            install-via: pip
    steps:
      - uses: actions/checkout@v7.0.0
 
      - name: Setup Python Versions
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: |
            3.10
            3.11
            3.12
            3.13
            3.14
          allow-prereleases: true
        if: matrix.os != 'macos-latest'
      - name: Setup Python Versions
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: |
            3.10
            3.11
            3.12
            3.13
            3.14
          allow-prereleases: true
        if: matrix.os == 'macos-latest'
      - name: Setup Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
          allow-prereleases: true
 
      - name: Cache venv
        uses: actions/cache@v6.1.0
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('pdm.lock') }}
      - name: Install uv
        uses: astral-sh/setup-uv@v8.2.0
        with:
          version: "latest"
      - name: Install current PDM via pip
        if: matrix.install-via == 'pip'
        run: python -m pip install -U .
      - name: Install current PDM via script
        if: matrix.install-via == 'script'
        run: |
          shasum -a256 --check install-pdm.py.sha256
          python install-pdm.py --version head
          echo "$HOME/.local/bin" >> $GITHUB_PATH
      - name: Install Dev Dependencies
        run: |
          pdm install -v -Gtest
          pdm run pip install -U setuptools
          pdm info
      # - name: Setup tmate session
      #   uses: mxschmitt/action-tmate@v3.22
      - name: Run Tests
        run: pdm run pytest -n auto --cov=pdm --cov-config=pyproject.toml --cov-report=xml tests
 
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v7.0.0
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: ./coverage.xml
          flags: unittests
 
  Pack:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v7.0.0
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: 3.x
      - name: Install PDM
        run: |
          python -m pip install .
          pdm self add pdm-packer
      - name: Pack pdm
        run: pdm pack
 
      - name: Test zipapp
        run: python pdm.pyz --version

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

3 third-party actions are referenced by a movable tag. Pin them 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 2 jobs (16 with the matrix expanded) 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 astral-sh/setup-uv codecov/codecov-action