Format workflow (mochajs/mocha)

The Format workflow from mochajs/mocha, explained and optimized by Latchkey.

What it does

This is the Format workflow from the mochajs/mocha 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: Format

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
    types: [opened, synchronize, reopened, edited]
  workflow_dispatch:

permissions:
  contents: read
  id-token: write # for Codecov OIDC (required by npm-script.yml)

jobs:
  format:
    uses: ./.github/workflows/npm-script.yml
    with:
      npm-script: format:check

The same workflow, on Latchkey

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

name: Format
 
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
    types: [opened, synchronize, reopened, edited]
  workflow_dispatch:
 
permissions:
  contents: read
  id-token: write # for Codecov OIDC (required by npm-script.yml)
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  format:
    timeout-minutes: 30
    uses: ./.github/workflows/npm-script.yml
    with:
      npm-script: format:check
 

What changed

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

This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.