formatting workflow (viser-project/viser)

The formatting workflow from viser-project/viser, explained and optimized by Latchkey.

What it does

This is the formatting workflow from the viser-project/viser repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: formatting

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

concurrency:
  group: formatting-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          enable-cache: true
      - name: Run Ruff
        run: uvx ruff check docs/ src/ examples/ --output-format github
      - name: Run Ruff format
        run: uvx ruff format docs/ src/ examples/ --check

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: formatting
 
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
 
concurrency:
  group: formatting-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - uses: actions/checkout@v4
      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          enable-cache: true
      - name: Run Ruff
        run: uvx ruff check docs/ src/ examples/ --output-format github
      - name: Run Ruff format
        run: uvx ruff format docs/ src/ examples/ --check
 

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.
• 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 per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow