Build docs workflow (patrick-kidger/equinox)

The Build docs workflow from patrick-kidger/equinox, explained and optimized by Latchkey.

What it does

This is the Build docs workflow from the patrick-kidger/equinox 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: Build docs

on:
  push:
    branches:
      - main

jobs:
  build:
    strategy:
      matrix:
        python-version: [ 3.11 ]
        os: [ ubuntu-latest ]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@v7
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install dependencies
        run: |
          uv run echo done

      - name: Build docs
        run: |
          uv run mkdocs build

      - name: Upload docs
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: site  # where `mkdocs build` puts the built site

The same workflow, on Latchkey

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

name: Build docs
 
on:
  push:
    branches:
      - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    strategy:
      matrix:
        python-version: [ 3.11 ]
        os: [ ubuntu-latest ]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
 
      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@v7
        with:
          python-version: ${{ matrix.python-version }}
 
      - name: Install dependencies
        run: |
          uv run echo done
 
      - name: Build docs
        run: |
          uv run mkdocs build
 
      - name: Upload docs
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: site  # where `mkdocs build` puts the built site
 

What changed

• Cancel superseded runs when a branch or PR gets a newer push.
• 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