API Surface Check workflow (sebastianbergmann/phpunit)

The API Surface Check workflow from sebastianbergmann/phpunit, explained and optimized by Latchkey.

What it does

This is the API Surface Check workflow from the sebastianbergmann/phpunit 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

# https://github.com/marketplace/actions/api-surface-check-for-php

on:
  pull_request:
    paths-ignore:
      - ".editorconfig"
      - "LICENSE"
      - "**.md"
      - "**.png"
      - "**.svg"
      - "tests/**"

name: "API Surface Check"

permissions: {}

concurrency:
  group: api-surface-${{ github.event.pull_request.number }}
  cancel-in-progress: true

jobs:
  signal:
    name: Signal
    runs-on: ubuntu-latest
    steps:
      - run: "true"

The same workflow, on Latchkey

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

# https://github.com/marketplace/actions/api-surface-check-for-php
 
on:
  pull_request:
    paths-ignore:
      - ".editorconfig"
      - "LICENSE"
      - "**.md"
      - "**.png"
      - "**.svg"
      - "tests/**"
 
name: "API Surface Check"
 
permissions: {}
 
concurrency:
  group: api-surface-${{ github.event.pull_request.number }}
  cancel-in-progress: true
 
jobs:
  signal:
    timeout-minutes: 30
    name: Signal
    runs-on: latchkey-small
    steps:
      - run: "true"
 

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.

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