Docs CI workflow (eslint/eslint)

The Docs CI workflow from eslint/eslint, explained and optimized by Latchkey.

What it does

This is the Docs CI workflow from the eslint/eslint 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 CI
on:
    push:
        branches: [main]
        paths:
            - "docs/**"

    pull_request:
        branches: [main]
        paths:
            - "docs/**"

permissions:
    contents: read

jobs:
    verify_files:
        name: Verify Docs Files
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v7
            - uses: actions/setup-node@v6
              with:
                  node-version: "24" # Should be the same as the version used on Netlify to build the docs site

            - name: Install Docs Packages
              working-directory: docs
              run: npm install

            - name: Install Packages
              run: npm install

            - name: Stylelint Docs
              working-directory: docs
              run: npm run lint:scss

            - name: Build Docs Website
              working-directory: docs
              run: npm run build

            - name: Validate internal links
              working-directory: docs
              run: npm run lint:links

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

name: Docs CI
on:
    push:
        branches: [main]
        paths:
            - "docs/**"
 
    pull_request:
        branches: [main]
        paths:
            - "docs/**"
 
permissions:
    contents: read
 
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true
 
jobs:
    verify_files:
        timeout-minutes: 30
        name: Verify Docs Files
        runs-on: latchkey-small
        steps:
            - uses: actions/checkout@v7
            - uses: actions/setup-node@v6
              with:
                  cache: 'npm'
                  node-version: "24" # Should be the same as the version used on Netlify to build the docs site
 
            - name: Install Docs Packages
              working-directory: docs
              run: npm install
 
            - name: Install Packages
              run: npm install
 
            - name: Stylelint Docs
              working-directory: docs
              run: npm run lint:scss
 
            - name: Build Docs Website
              working-directory: docs
              run: npm run build
 
            - name: Validate internal links
              working-directory: docs
              run: npm run lint:links
 

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.
• Cache dependency installs on the setup step so they are served from cache.
• 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 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