check workflow (codeceptjs/CodeceptJS)

The check workflow from codeceptjs/CodeceptJS, explained and optimized by Latchkey.

What it does

This is the check workflow from the codeceptjs/CodeceptJS 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

on:
  push:
    branches:
      - 4.x
  pull_request:
    branches:
      - '**'

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  test:
    runs-on: ubuntu-22.04
    name: Check Tests
    steps:
    - uses: actions/checkout@v6
      with:
        fetch-depth: 0
    - uses: testomatio/check-tests@stable
      if: github.repository == 'codeceptjs/CodeceptJS' && github.event.pull_request.title == '4.x'
      with:
        framework: mocha
        tests: "./test/**/*_test.js"
        token: ${{ secrets.GITHUB_TOKEN }}
        has-tests-label: true
        comment-on-empty: true
        github-pat: ${{ secrets.GH_PAT }}
        enable-documentation: true
        documentation-branch: "master"

The same workflow, on Latchkey

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

on:
  push:
    branches:
      - 4.x
  pull_request:
    branches:
      - '**'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
    name: Check Tests
    steps:
    - uses: actions/checkout@v6
      with:
        fetch-depth: 0
    - uses: testomatio/check-tests@stable
      if: github.repository == 'codeceptjs/CodeceptJS' && github.event.pull_request.title == '4.x'
      with:
        framework: mocha
        tests: "./test/**/*_test.js"
        token: ${{ secrets.GITHUB_TOKEN }}
        has-tests-label: true
        comment-on-empty: true
        github-pat: ${{ secrets.GH_PAT }}
        enable-documentation: true
        documentation-branch: "master"
 

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.

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