CI workflow (timofurrer/pandoc-plantuml-filter)

The CI workflow from timofurrer/pandoc-plantuml-filter, 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: timofurrer/pandoc-plantuml-filter.github/workflows/main.ymlLicense MITView source

What it does

This is the CI workflow from the timofurrer/pandoc-plantuml-filter 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: CI

on: [push, pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.13
        uses: actions/setup-python@v5
        with:
          python-version: 3.13
      - name: Setup and install tools
        run: |
          python -m pip install --upgrade ruff
      - name: format check
        run: python -m ruff format --check
      - name: lint check
        run: python -m ruff check
  test:
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.8, 3.13]

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Setup build and test environment
        run: python -m pip install --upgrade pip build pytest pytest-mock
      - name: Build package
        run: python -m build
      - name: Install package
        run: python -m pip install --pre dist/pandoc_plantuml_filter-*.whl
      - name: run unit tests
        run: python -m pytest tests/test_unit.py
      - name: install dependencies for integration tests
        run: sudo apt update && sudo apt install -y pandoc plantuml
      - name: run integration tests
        run: python -m pytest tests/test_integration.py

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, pull_request]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  lint:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.13
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: 3.13
      - name: Setup and install tools
        run: |
          python -m pip install --upgrade ruff
      - name: format check
        run: python -m ruff format --check
      - name: lint check
        run: python -m ruff check
  test:
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.8, 3.13]
 
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
      - name: Setup build and test environment
        run: python -m pip install --upgrade pip build pytest pytest-mock
      - name: Build package
        run: python -m build
      - name: Install package
        run: python -m pip install --pre dist/pandoc_plantuml_filter-*.whl
      - name: run unit tests
        run: python -m pytest tests/test_unit.py
      - name: install dependencies for integration tests
        run: sudo apt update && sudo apt install -y pandoc plantuml
      - name: run integration tests
        run: python -m pytest tests/test_integration.py

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 2 jobs (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

actions/checkout actions/setup-python