API Extrator workflow (react-hook-form/react-hook-form)

The API Extrator workflow from react-hook-form/react-hook-form, explained and optimized by Latchkey.

What it does

This is the API Extrator workflow from the react-hook-form/react-hook-form 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: API Extrator

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

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

      - name: Install Dependencies
        uses: ./.github/actions/install-dependencies

      - name: Build
        run: pnpm build:esm

      - name: API Extractor
        run: pnpm api-extractor:ci

The same workflow, on Latchkey

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

name: API Extrator
 
on: [pull_request]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - name: Checkout repo
        uses: actions/checkout@v6
 
      - name: Install Dependencies
        uses: ./.github/actions/install-dependencies
 
      - name: Build
        run: pnpm build:esm
 
      - name: API Extractor
        run: pnpm api-extractor:ci
 

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.

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