Broken Links Scan workflow (wix/Detox)

The Broken Links Scan workflow from wix/Detox, explained and optimized by Latchkey.

What it does

This is the Broken Links Scan 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

name: Broken Links Scan

on:
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * *'

jobs:
  remark:
    name: Remark
    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 remark -r .remarkrc.nightly.mjs .

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: Broken Links Scan
 
on:
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * *'
 
jobs:
  remark:
    timeout-minutes: 30
    name: Remark
    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 remark -r .remarkrc.nightly.mjs .
 

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