Test on Commit workflow (obgnail/typora_plugin)

The Test on Commit workflow from obgnail/typora_plugin, explained and optimized by Latchkey.

What it does

This is the Test on Commit workflow from the obgnail/typora_plugin 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: Test on Commit

on:
  push:
    paths:
      - 'develop/**'
      - 'plugin/**'
      - '.github/**'

jobs:
  test:
    runs-on: ubuntu-latest

    defaults:
      run:
        working-directory: ./develop

    strategy:
      matrix:
        node-version: [20.x, 24.x]

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v6
        with:
          node-version: ${{ matrix.node-version }}
          cache: 'npm'
          cache-dependency-path: develop/package-lock.json

      - name: Install dependencies
        run: npm ci

      - name: Run tests
        run: npm test

The same workflow, on Latchkey

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

name: Test on Commit
 
on:
  push:
    paths:
      - 'develop/**'
      - 'plugin/**'
      - '.github/**'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    defaults:
      run:
        working-directory: ./develop
 
    strategy:
      matrix:
        node-version: [20.x, 24.x]
 
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
 
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v6
        with:
          node-version: ${{ matrix.node-version }}
          cache: 'npm'
          cache-dependency-path: develop/package-lock.json
 
      - name: Install dependencies
        run: npm ci
 
      - name: Run tests
        run: npm test
 

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

Actions used in this workflow