CI workflow (thomaspark/bootswatch)

The CI workflow from thomaspark/bootswatch, 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: thomaspark/bootswatch.github/workflows/ci.ymlLicense MITView source

What it does

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

on:
  push:
    branches:
      - "**"
      - "!dependabot/**"
  pull_request:
  workflow_dispatch:

env:
  FORCE_COLOR: 2
  NODE_LTS: 18

permissions:
  contents: read

jobs:
  build:
    name: Build on Node ${{ matrix.node }}
    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        node: [14, 16, 18]

    steps:
      - name: Clone repository
        uses: actions/checkout@v3
        with:
          persist-credentials: false

      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: ${{ matrix.node }}
          cache: npm

      - name: Install npm dependencies
        run: npm ci

      - name: Build themes
        run: npm run build

      - name: Build docs
        run: npm run docs

  test:
    name: Test
    runs-on: ubuntu-latest

    steps:
      - name: Clone repository
        uses: actions/checkout@v3
        with:
          persist-credentials: false

      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: ${{ env.NODE_LTS }}
          cache: npm

      - run: java -version

      - name: Install npm dependencies
        run: npm ci

      - name: Run tests
        run: npm test

      - name: Run vnu-jar
        run: npm run htmllint

The same workflow, on Latchkey

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

name: CI
 
on:
  push:
    branches:
      - "**"
      - "!dependabot/**"
  pull_request:
  workflow_dispatch:
 
env:
  FORCE_COLOR: 2
  NODE_LTS: 18
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    name: Build on Node ${{ matrix.node }}
    runs-on: latchkey-small
 
    strategy:
      fail-fast: false
      matrix:
        node: [14, 16, 18]
 
    steps:
      - name: Clone repository
        uses: actions/checkout@v3
        with:
          persist-credentials: false
 
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: ${{ matrix.node }}
          cache: npm
 
      - name: Install npm dependencies
        run: npm ci
 
      - name: Build themes
        run: npm run build
 
      - name: Build docs
        run: npm run docs
 
  test:
    timeout-minutes: 30
    name: Test
    runs-on: latchkey-small
 
    steps:
      - name: Clone repository
        uses: actions/checkout@v3
        with:
          persist-credentials: false
 
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: ${{ env.NODE_LTS }}
          cache: npm
 
      - run: java -version
 
      - name: Install npm dependencies
        run: npm ci
 
      - name: Run tests
        run: npm test
 
      - name: Run vnu-jar
        run: npm run htmllint

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.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

Dependency installs

This workflow runs 2 jobs (4 with the matrix expanded) 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 actions/setup-node