Doc Check workflow (jackwener/OpenCLI)

The Doc Check workflow from jackwener/OpenCLI, explained and optimized by Latchkey.

What it does

This is the Doc Check workflow from the jackwener/OpenCLI 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: Doc Check

on:
  pull_request:
    branches: [main, dev]

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

jobs:
  # ── Adapter doc coverage ──
  doc-coverage:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Check adapter doc coverage
        run: bash scripts/check-doc-coverage.sh --strict

  # ── VitePress build validation ──
  docs-build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-node@v6
        with:
          node-version: '22'
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Build docs (catches broken links & sidebar refs)
        run: npm run docs:build

The same workflow, on Latchkey

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

name: Doc Check
 
on:
  pull_request:
    branches: [main, dev]
 
concurrency:
  group: doc-check-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  # ── Adapter doc coverage ──
  doc-coverage:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v6
 
      - name: Check adapter doc coverage
        run: bash scripts/check-doc-coverage.sh --strict
 
  # ── VitePress build validation ──
  docs-build:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v6
 
      - uses: actions/setup-node@v6
        with:
          node-version: '22'
          cache: 'npm'
 
      - name: Install dependencies
        run: npm ci
 
      - name: Build docs (catches broken links & sidebar refs)
        run: npm run docs:build
 

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.

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