Runner Tests workflow (atong01/conditional-flow-matching)

The Runner Tests workflow from atong01/conditional-flow-matching, 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: atong01/conditional-flow-matching.github/workflows/test_runner.yamlLicense MITView source

What it does

This is the Runner Tests workflow from the atong01/conditional-flow-matching 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: Runner Tests

#on:
#  push:
#    branches: [main]
#  pull_request:
#    branches: [main, "release/*"]

jobs:
  run_tests_ubuntu:
    runs-on: ${{ matrix.os }}

    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, ubuntu-20.04, macos-latest, windows-latest]
        python-version: ["3.9", "3.10"]

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

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

      - name: Install dependencies
        run: |
          # Fix pip version < 24.1 due to lightning incomaptibility
          python -m pip install pip==23.2.1
          pip install -r runner-requirements.txt
          pip install pytest
          pip install sh
          pip install -e .

      - name: List dependencies
        run: |
          python -m pip list

      - name: Run pytest
        run: |
          pytest -v runner

  # upload code coverage report
  code-coverage-runner:
    runs-on: ubuntu-latest

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

      - name: Set up Python 3.10
        uses: actions/setup-python@v6
        with:
          python-version: "3.10"

      - name: Install dependencies
        run: |
          # Fix pip version < 24.1 due to lightning incomaptibility
          python -m pip install pip==23.2.1
          pip install -r runner-requirements.txt
          pip install pytest
          pip install pytest-cov[toml]
          pip install sh
          pip install -e .

      - name: Run tests and collect coverage
        run: pytest runner --cov runner --cov-fail-under=30 # NEEDS TO BE UPDATED WHEN CHANGING THE NAME OF "src" FOLDER

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v3
        with:
          name: codecov-runner
          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: Runner Tests
 
#on:
#  push:
#    branches: [main]
#  pull_request:
#    branches: [main, "release/*"]
 
jobs:
  run_tests_ubuntu:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}
 
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, ubuntu-20.04, macos-latest, windows-latest]
        python-version: ["3.9", "3.10"]
 
    steps:
      - name: Checkout
        uses: actions/checkout@v5
 
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Install dependencies
        run: |
          # Fix pip version < 24.1 due to lightning incomaptibility
          python -m pip install pip==23.2.1
          pip install -r runner-requirements.txt
          pip install pytest
          pip install sh
          pip install -e .
 
      - name: List dependencies
        run: |
          python -m pip list
 
      - name: Run pytest
        run: |
          pytest -v runner
 
  # upload code coverage report
  code-coverage-runner:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - name: Checkout
        uses: actions/checkout@v5
 
      - name: Set up Python 3.10
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: "3.10"
 
      - name: Install dependencies
        run: |
          # Fix pip version < 24.1 due to lightning incomaptibility
          python -m pip install pip==23.2.1
          pip install -r runner-requirements.txt
          pip install pytest
          pip install pytest-cov[toml]
          pip install sh
          pip install -e .
 
      - name: Run tests and collect coverage
        run: pytest runner --cov runner --cov-fail-under=30 # NEEDS TO BE UPDATED WHEN CHANGING THE NAME OF "src" FOLDER
 
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v3
        with:
          name: codecov-runner
          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.
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 2 jobs (9 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 codecov/codecov-action