Create Build Size Report workflow (highlightjs/highlight.js)

The Create Build Size Report workflow from highlightjs/highlight.js, explained and optimized by Latchkey.

What it does

This is the Create Build Size Report workflow from the highlightjs/highlight.js 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: Create Build Size Report

on:
  pull_request:

jobs:
  run:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Base
        uses: actions/checkout@v7
        with:
          ref: ${{ github.event.pull_request.base.ref }}
          path: base

      - name: Checkout PR
        uses: actions/checkout@v7
        with:
          path: pr

      - name: Build CDN (Base)
        run: |
          npm ci
          npm run build-cdn
        working-directory: ./base

      - name: Build CDN (PR)
        run: |
          npm ci
          npm run build-cdn
        working-directory: ./pr

      - name: Create Size Report
        run: |
          mkdir size_report
          echo ${{ github.event.number }} > size_report/pull_req_nr
          REPORT=$(./pr/tools/buildSizeReport.js ./base/build ./pr/build)
          echo "$REPORT" > size_report/report.md

      - name: Save Size Report as Artifact
        uses: actions/upload-artifact@v7
        with:
          name: size_report
          path: ./size_report

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: Create Build Size Report
 
on:
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  run:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - name: Checkout Base
        uses: actions/checkout@v7
        with:
          ref: ${{ github.event.pull_request.base.ref }}
          path: base
 
      - name: Checkout PR
        uses: actions/checkout@v7
        with:
          path: pr
 
      - name: Build CDN (Base)
        run: |
          npm ci
          npm run build-cdn
        working-directory: ./base
 
      - name: Build CDN (PR)
        run: |
          npm ci
          npm run build-cdn
        working-directory: ./pr
 
      - name: Create Size Report
        run: |
          mkdir size_report
          echo ${{ github.event.number }} > size_report/pull_req_nr
          REPORT=$(./pr/tools/buildSizeReport.js ./base/build ./pr/build)
          echo "$REPORT" > size_report/report.md
 
      - name: Save Size Report as Artifact
        uses: actions/upload-artifact@v7
        with:
          name: size_report
          path: ./size_report
 

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