Check for changeset workflow (primer/octicons)

The Check for changeset workflow from primer/octicons, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: primer/octicons.github/workflows/check_for_changeset.ymlLicense MITView source

What it does

This is the Check for changeset workflow from the primer/octicons 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

workflow (.yml)

name: Check for changeset

on:
  pull_request:
    types:
      # On by default if you specify no types.
      - 'opened'
      - 'reopened'
      - 'synchronize'
      # For `skip changeset` only.
      - 'labeled'
      - 'unlabeled'

jobs:
  check-for-changeset:
    name: Check for changeset
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: 'Check for changeset'
        uses: brettcannon/check-for-changed-files@v1
        with:
          file-pattern: '.changeset/*.md'
          skip-label: 'skip changeset'
          failure-message: 'No changeset found. If these changes should not result in a new version, apply the ${skip-label} label to this pull request. If these changes should result in a version bump, please add a changeset https://git.io/J6QvQ'

The same workflow, on Latchkey

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

name: Check for changeset
 
on:
  pull_request:
    types:
      # On by default if you specify no types.
      - 'opened'
      - 'reopened'
      - 'synchronize'
      # For `skip changeset` only.
      - 'labeled'
      - 'unlabeled'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  check-for-changeset:
    timeout-minutes: 30
    name: Check for changeset
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
      - name: 'Check for changeset'
        uses: brettcannon/check-for-changed-files@v1
        with:
          file-pattern: '.changeset/*.md'
          skip-label: 'skip changeset'
          failure-message: 'No changeset found. If these changes should not result in a new version, apply the ${skip-label} label to this pull request. If these changes should result in a version bump, please add a changeset https://git.io/J6QvQ'

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.

1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

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

actions/checkout