Code coverage workflow (qunitjs/qunit)

The Code coverage workflow from qunitjs/qunit, explained and optimized by Latchkey.

What it does

This is the Code coverage workflow from the qunitjs/qunit 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: Code coverage
on:
  - push

jobs:
  run:
    name: Code coverage
    if: ${{ github.repository == 'qunitjs/qunit' }} # skip on forks, needs secret
    runs-on: ubuntu-latest
    env:
      PUPPETEER_CACHE_DIR: "${{ github.workspace }}/.puppeteer_download"
      FORCE_COLOR: "1"
    steps:
      - uses: actions/checkout@v6

      - uses: actions/cache@v5
        with:
          path: |
            ~/.npm
            ${{ github.workspace }}/.puppeteer_download
          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}

      - name: Use Node.js 18
        uses: actions/setup-node@v6
        with:
          node-version: 18.x

      - run: npm install

      - name: Tests
        run: npm run coverage

      - name: Upload to coveralls.io
        if: ${{ github.ref_name == 'main' }} # skip upload on non-main branches
        env:
          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.5.2/php-coveralls.phar
          chmod +x php-coveralls.phar
          ./php-coveralls.phar -v --coverage_clover coverage/clover.xml --json_path coverage/coveralls.json

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: Code coverage
on:
  - push
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  run:
    timeout-minutes: 30
    name: Code coverage
    if: ${{ github.repository == 'qunitjs/qunit' }} # skip on forks, needs secret
    runs-on: latchkey-small
    env:
      PUPPETEER_CACHE_DIR: "${{ github.workspace }}/.puppeteer_download"
      FORCE_COLOR: "1"
    steps:
      - uses: actions/checkout@v6
 
      - uses: actions/cache@v5
        with:
          path: |
            ~/.npm
            ${{ github.workspace }}/.puppeteer_download
          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
 
      - name: Use Node.js 18
        uses: actions/setup-node@v6
        with:
          cache: 'npm'
          node-version: 18.x
 
      - run: npm install
 
      - name: Tests
        run: npm run coverage
 
      - name: Upload to coveralls.io
        if: ${{ github.ref_name == 'main' }} # skip upload on non-main branches
        env:
          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.5.2/php-coveralls.phar
          chmod +x php-coveralls.phar
          ./php-coveralls.phar -v --coverage_clover coverage/clover.xml --json_path coverage/coveralls.json
 

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.

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
• Network fetches

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