CI workflow (timsutton/brigadier)

The CI workflow from timsutton/brigadier, explained and optimized by Latchkey.

What it does

This is the CI workflow from the timsutton/brigadier 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: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  build:
    runs-on: windows-2019
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Build
        run: bash .\ci\windows\ci-windows.sh

      - name: Archive
        uses: actions/upload-artifact@v3
        with:
          name: brigadier-windows-exe
          path: D:\a\brigadier\brigadier\dist

      # Running the command as a test isn't really useful to us yet
      # - name: Test
      #   run: bash .\ci\windows\test.sh

The same workflow, on Latchkey

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

name: CI
 
on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
 
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: windows-2019
    steps:
      - name: Checkout
        uses: actions/checkout@v3
 
      - name: Build
        run: bash .\ci\windows\ci-windows.sh
 
      - name: Archive
        uses: actions/upload-artifact@v3
        with:
          name: brigadier-windows-exe
          path: D:\a\brigadier\brigadier\dist
 
      # Running the command as a test isn't really useful to us yet
      # - name: Test
      #   run: bash .\ci\windows\test.sh
 

What changed

• 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