Doclint workflow (wix/Detox)

The Doclint workflow from wix/Detox, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: wix/Detox.github/workflows/docs.ymlLicense MITView source

What it does

This is the Doclint workflow from the wix/Detox 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

workflow (.yml)

name: Doclint

on:
  push:
    branches: [master]
    paths:
      - '.github/workflows/docs.yml'
      - '.markdownlintrc'
      - '.remarkignore'
      - '.remarkrc.mjs'
      - '.retext-spell.dic'
      - 'package.json'
      - 'docs/**'
      - '**.md'
  pull_request:
    branches: [master]
    paths:
      - '.github/workflows/docs.yml'
      - '.markdownlintrc'
      - '.remarkignore'
      - '.remarkrc.mjs'
      - '.retext-spell.dic'
      - 'package.json'
      - 'docs/**'
      - '**.md'

jobs:
  markdownlint:
    name: Markdown
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744
      - uses: actions/setup-node@3235b876344d2a9aa001b8d1453c930bba69e610
        with:
          node-version-file: '.nvmrc'
      - name: Enable Corepack
        run: corepack enable
      - name: Install dependencies
        run: yes | npx npq install --immutable
        env:
          NPQ_PKG_MGR: yarn
      - run: yarn docs:lint

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: Doclint
 
on:
  push:
    branches: [master]
    paths:
      - '.github/workflows/docs.yml'
      - '.markdownlintrc'
      - '.remarkignore'
      - '.remarkrc.mjs'
      - '.retext-spell.dic'
      - 'package.json'
      - 'docs/**'
      - '**.md'
  pull_request:
    branches: [master]
    paths:
      - '.github/workflows/docs.yml'
      - '.markdownlintrc'
      - '.remarkignore'
      - '.remarkrc.mjs'
      - '.retext-spell.dic'
      - 'package.json'
      - 'docs/**'
      - '**.md'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  markdownlint:
    timeout-minutes: 30
    name: Markdown
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744
      - uses: actions/setup-node@3235b876344d2a9aa001b8d1453c930bba69e610
        with:
          cache: 'npm'
          node-version-file: '.nvmrc'
      - name: Enable Corepack
        run: corepack enable
      - name: Install dependencies
        run: yes | npx npq install --immutable
        env:
          NPQ_PKG_MGR: yarn
      - run: yarn docs:lint

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.

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

actions/checkout actions/setup-node