Build and Run Test Suite workflow (kuroko-lang/kuroko)

The Build and Run Test Suite workflow from kuroko-lang/kuroko, explained and optimized by Latchkey.

CI health: C - fair

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

Grade your own workflow free or run it on Latchkey →

Source: kuroko-lang/kuroko.github/workflows/build.ymlLicense MITView source

What it does

This is the Build and Run Test Suite workflow from the kuroko-lang/kuroko 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)

on: [push, workflow_dispatch]
name: Build and Run Test Suite
jobs:
  Build-on-Ubuntu:
    runs-on: ubuntu-latest
    steps:
      - name: Clone Repository
        uses: actions/checkout@v2
      - name: Build
        run:  make clean && make
      - name: Test
        run:  make test
  Build-on-MacOS:
    runs-on: macos-latest
    steps:
      - name: Clone Repository
        uses: actions/checkout@v2
      - name: Build
        run:  make clean && make
      - name: Test
        run:  make test

The same workflow, on Latchkey

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

on: [push, workflow_dispatch]
name: Build and Run Test Suite
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  Build-on-Ubuntu:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Clone Repository
        uses: actions/checkout@v2
      - name: Build
        run:  make clean && make
      - name: Test
        run:  make test
  Build-on-MacOS:
    timeout-minutes: 30
    runs-on: macos-latest
    steps:
      - name: Clone Repository
        uses: actions/checkout@v2
      - name: Build
        run:  make clean && make
      - name: Test
        run:  make test

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 2 jobs 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