Tests: pretest/posttest workflow (import-js/eslint-plugin-import)
The Tests: pretest/posttest workflow from import-js/eslint-plugin-import, explained and optimized by Latchkey.
CI health: C - fair
Point runs-on at Latchkey and get 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 Tests: pretest/posttest workflow from the import-js/eslint-plugin-import 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: 'Tests: pretest/posttest'
on: [pull_request, push]
permissions:
contents: read
jobs:
# pretest:
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# - uses: ljharb/actions/node/install@main
# name: 'nvm install lts/* && npm install'
# with:
# node-version: 'lts/*'
# skip-ls-check: true
# - run: npm run pretest
types:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ljharb/actions/node/install@main
name: 'npm install'
with:
skip-ls-check: true
# for some reason we've got to force typescript to install here
# even though the npm script has `typescript@latest`
- run: npm i --force typescript@latest
- run: npm run test-types
posttest:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ljharb/actions/node/install@main
name: 'nvm install lts/* && npm install'
with:
node-version: 'lts/*'
skip-ls-check: true
- run: npm run posttest
The same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
name: 'Tests: pretest/posttest' on: [pull_request, push] permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: # pretest: # runs-on: latchkey-small # steps: # - uses: actions/checkout@v4 # - uses: ljharb/actions/node/install@main # name: 'nvm install lts/* && npm install' # with: # node-version: 'lts/*' # skip-ls-check: true # - run: npm run pretest types: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@v4 - uses: ljharb/actions/node/install@main name: 'npm install' with: skip-ls-check: true # for some reason we've got to force typescript to install here # even though the npm script has `typescript@latest` - run: npm i --force typescript@latest - run: npm run test-types posttest: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@v4 - uses: ljharb/actions/node/install@main name: 'nvm install lts/* && npm install' with: node-version: 'lts/*' skip-ls-check: true - run: npm run posttest
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.
- 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 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.