Run tests workflow (prose/prose)

The Run tests workflow from prose/prose, explained and optimized by Latchkey.

What it does

This is the Run tests workflow from the prose/prose repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: Run tests

on:
  pull_request_target:
    types: [assigned, opened, synchronize, reopened]

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Use Node.js 20
      uses: actions/setup-node@v3
      with:
        node-version: 20.x
    - name: Install dependencies
      run: |
        npm install
    - name: Run Test Suite
      run: |
        npm test
    - name: Build app
      run: |
        npm run build

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: Run tests
 
on:
  pull_request_target:
    types: [assigned, opened, synchronize, reopened]
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v3
 
    - name: Use Node.js 20
      uses: actions/setup-node@v3
      with:
        cache: 'npm'
        node-version: 20.x
    - name: Install dependencies
      run: |
        npm install
    - name: Run Test Suite
      run: |
        npm test
    - name: Build app
      run: |
        npm run build

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.

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