CI workflow (pyllyukko/user.js)

The CI workflow from pyllyukko/user.js, explained and optimized by Latchkey.

What it does

This is the CI workflow from the pyllyukko/user.js 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: CI
on:
  push:
concurrency:
  group: ${{ github.ref }}
  cancel-in-progress: true
jobs:
  tests:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Install test utilities
        run: sudo apt install make node-acorn shellcheck
      - name: Run tests
        run: make tests
  ssllabs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install Firefox
        run: sudo apt install firefox
      - name: Create profile directory
        run: |
          mkdir -v tmp
          ln -sv ../user.js tmp/user.js
          ls -l user.js tmp/user.js
      - name: Screenshot SSL Labs
        run: firefox --profile tmp -screenshot https://www.ssllabs.com/ssltest/viewMyClient.html
      - name: Check profile directory
        run: ls -l tmp/
      - name: Archive screenshot
        uses: actions/upload-artifact@v4
        with:
          name: screenshot.png
          path: ./screenshot.png

The same workflow, on Latchkey

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

name: CI
on:
  push:
concurrency:
  group: ${{ github.ref }}
  cancel-in-progress: true
jobs:
  tests:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Install test utilities
        run: sudo apt install make node-acorn shellcheck
      - name: Run tests
        run: make tests
  ssllabs:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install Firefox
        run: sudo apt install firefox
      - name: Create profile directory
        run: |
          mkdir -v tmp
          ln -sv ../user.js tmp/user.js
          ls -l user.js tmp/user.js
      - name: Screenshot SSL Labs
        run: firefox --profile tmp -screenshot https://www.ssllabs.com/ssltest/viewMyClient.html
      - name: Check profile directory
        run: ls -l tmp/
      - name: Archive screenshot
        uses: actions/upload-artifact@v4
        with:
          name: screenshot.png
          path: ./screenshot.png
 

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.
• 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 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow