CI workflow (Cloxl/xhshow)

The CI workflow from Cloxl/xhshow, explained and optimized by Latchkey.

What it does

This is the CI workflow from the Cloxl/xhshow 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: CI

on:
  push:
    branches: [ master, main, dev, refactor/* ]
  pull_request:
    branches: [ master, main, dev ]

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"]

    steps:
    - uses: actions/checkout@v4
    
    - name: Install uv
      uses: astral-sh/setup-uv@v4
      with:
        version: "latest"
    
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    
    - name: Install dependencies
      run: |
        uv sync --dev
    
    - name: Generate version file
      run: |
        uv build --wheel
    
    - name: Run tests
      run: |
        uv run pytest tests/ -v --tb=short
    
    - name: Run linting and type checking
      run: |
        uv run ruff check src/ tests/ --ignore=UP036,E501 --output-format=github
    
    - name: Check code formatting
      run: |
        uv run ruff format --check src/ tests/

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: CI
 
on:
  push:
    branches: [ master, main, dev, refactor/* ]
  pull_request:
    branches: [ master, main, dev ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"]
 
    steps:
    - uses: actions/checkout@v4
    
    - name: Install uv
      uses: astral-sh/setup-uv@v4
      with:
        version: "latest"
    
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    
    - name: Install dependencies
      run: |
        uv sync --dev
    
    - name: Generate version file
      run: |
        uv build --wheel
    
    - name: Run tests
      run: |
        uv run pytest tests/ -v --tb=short
    
    - name: Run linting and type checking
      run: |
        uv run ruff check src/ tests/ --ignore=UP036,E501 --output-format=github
    
    - name: Check code formatting
      run: |
        uv run ruff format --check src/ tests/

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.

This workflow runs 1 job (3 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