ci workflow (yargs/yargs)
The ci workflow from yargs/yargs, explained and optimized by Latchkey.
CI health: F - at risk
Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the ci workflow from the yargs/yargs 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
on:
push:
branches:
- main
pull_request:
types: [assigned, opened, synchronize, reopened, labeled]
name: ci
permissions:
contents: read # to fetch code (actions/checkout)
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
node: [20, 22, 24]
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node }}
- run: npm install -g npm@8
- run: node --version
- run: npm install --engine-strict
- run: npm test
windows:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 24
- run: npm install -g npm@8
- run: npm install
- run: npm test
deno:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 22
- run: npm install -g npm@8
- run: npm install
- run: npm run compile
- uses: denoland/setup-deno@v1
with:
deno-version: v1.x
- run: |
deno --version
deno test --allow-read test/deno/*
coverage:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: 22
- run: npm install -g npm@8
- run: npm install
- run: npm test
- run: npm run coverage
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.
on: push: branches: - main pull_request: types: [assigned, opened, synchronize, reopened, labeled] name: ci permissions: contents: read # to fetch code (actions/checkout) concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: test: timeout-minutes: 30 runs-on: latchkey-small strategy: matrix: node: [20, 22, 24] steps: - uses: actions/checkout@v1 - uses: actions/setup-node@v1 with: cache: 'npm' node-version: ${{ matrix.node }} - run: npm install -g npm@8 - run: node --version - run: npm install --engine-strict - run: npm test windows: timeout-minutes: 30 runs-on: windows-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: cache: 'npm' node-version: 24 - run: npm install -g npm@8 - run: npm install - run: npm test deno: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: cache: 'npm' node-version: 22 - run: npm install -g npm@8 - run: npm install - run: npm run compile - uses: denoland/setup-deno@v1 with: deno-version: v1.x - run: | deno --version deno test --allow-read test/deno/* coverage: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@v1 - uses: actions/setup-node@v1 with: cache: 'npm' node-version: 22 - run: npm install -g npm@8 - run: npm install - run: npm test - run: npm run coverage
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 useslatchkey-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.
1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.
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 4 jobs (6 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.