Docs workflow (dgasmith/opt_einsum)

The Docs workflow from dgasmith/opt_einsum, explained and optimized by Latchkey.

What it does

This is the Docs workflow from the dgasmith/opt_einsum 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: Docs
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

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

    - uses: astral-sh/setup-uv@v5
      with:
        python-version: "3.12"
        enable-cache: true

    - name: Build Docs
      run: make docs

    # Only deploy if main, otherwise just build for testing
    - name: Deploy
      if: endsWith(github.ref, '/main')
      run: uv run --with ".[docs]" mkdocs gh-deploy --force

The same workflow, on Latchkey

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

name: Docs
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  deploy:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
    - uses: actions/checkout@v4
 
    - uses: astral-sh/setup-uv@v5
      with:
        python-version: "3.12"
        enable-cache: true
 
    - name: Build Docs
      run: make docs
 
    # Only deploy if main, otherwise just build for testing
    - name: Deploy
      if: endsWith(github.ref, '/main')
      run: uv run --with ".[docs]" mkdocs gh-deploy --force
 

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