🧪 Docs Test WorkFlow 📚 workflow (roboflow/maestro)

The 🧪 Docs Test WorkFlow 📚 workflow from roboflow/maestro, explained and optimized by Latchkey.

What it does

This is the 🧪 Docs Test WorkFlow 📚 workflow from the roboflow/maestro 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: 🧪 Docs Test WorkFlow 📚

on:
  pull_request:
    branches: [main, develop]

# Restrict permissions by default
permissions:
  contents: read # Required for checkout
  checks: write # Required for test reporting

jobs:
  docs-build-test:
    name: Test docs build
    runs-on: ubuntu-latest
    timeout-minutes: 10
    strategy:
      matrix:
        python-version: ["3.10"]
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0

      - name: 🐍 Install uv and set Python ${{ matrix.python-version }}
        uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355 # v5.2.2
        with:
          python-version: ${{ matrix.python-version }}

      - name: 🏗️ Install dependencies
        run: |
          uv pip install -r pyproject.toml --extra docs
          uv pip install -e ".[docs]"

      - name: 🧪 Test Docs Build
        run: uv run mkdocs build --verbose

The same workflow, on Latchkey

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

name: 🧪 Docs Test WorkFlow 📚
 
on:
  pull_request:
    branches: [main, develop]
 
# Restrict permissions by default
permissions:
  contents: read # Required for checkout
  checks: write # Required for test reporting
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  docs-build-test:
    name: Test docs build
    runs-on: latchkey-small
    timeout-minutes: 10
    strategy:
      matrix:
        python-version: ["3.10"]
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0
 
      - name: 🐍 Install uv and set Python ${{ matrix.python-version }}
        uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355 # v5.2.2
        with:
          python-version: ${{ matrix.python-version }}
 
      - name: 🏗️ Install dependencies
        run: |
          uv pip install -r pyproject.toml --extra docs
          uv pip install -e ".[docs]"
 
      - name: 🧪 Test Docs Build
        run: uv run mkdocs build --verbose
 

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.

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