Linting workflow (geometric-intelligence/topobench)

The Linting workflow from geometric-intelligence/topobench, explained and optimized by Latchkey.

CI health: F - at risk

Point runs-on at Latchkey and get caching, run de-duplication, 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: geometric-intelligence/topobench.github/workflows/lint.ymlLicense MITView source

What it does

This is the Linting workflow from the geometric-intelligence/topobench 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: Linting

on:
  push:
    branches: [ main, github-actions-test ]
  pull_request:

permissions:
  contents: read

jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # We use the official action from Astral (creators of uv & ruff)
      - name: Run Ruff
        uses: astral-sh/ruff-action@v3
        with:
          src: "./topobench"
          # This ensures the ruff version matches what you have in pyproject.toml
          version-file: "pyproject.toml"
          # Optional: fails the build if the code changes (e.g. formatting)
          changed-files: "true"

      - name: Run Ruff (format check)
        uses: astral-sh/ruff-action@v3
        with:
          src: "./topobench"
          version-file: "pyproject.toml"
          args: "format --check"

  pre-commit:
    # Runs the full pre-commit hook stack (numpydoc-validation, end-of-file,
    # trailing-whitespace, etc.) so the bar enforced locally is also enforced
    # in CI.
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - uses: pre-commit/action@v3.0.1

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: Linting
 
on:
  push:
    branches: [ main, github-actions-test ]
  pull_request:
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  ruff:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
 
      # We use the official action from Astral (creators of uv & ruff)
      - name: Run Ruff
        uses: astral-sh/ruff-action@v3
        with:
          src: "./topobench"
          # This ensures the ruff version matches what you have in pyproject.toml
          version-file: "pyproject.toml"
          # Optional: fails the build if the code changes (e.g. formatting)
          changed-files: "true"
 
      - name: Run Ruff (format check)
        uses: astral-sh/ruff-action@v3
        with:
          src: "./topobench"
          version-file: "pyproject.toml"
          args: "format --check"
 
  pre-commit:
    timeout-minutes: 30
    # Runs the full pre-commit hook stack (numpydoc-validation, end-of-file,
    # trailing-whitespace, etc.) so the bar enforced locally is also enforced
    # in CI.
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: "3.11"
      - uses: pre-commit/action@v3.0.1

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.

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

This workflow runs 2 jobs 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 astral-sh/ruff-action actions/setup-python pre-commit/action