CI workflow (feathericons/feather)

The CI workflow from feathericons/feather, explained and optimized by Latchkey.

What it does

This is the CI workflow from the feathericons/feather 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

jobs:
  ci:
    name: CI
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Setup Node.js 16.x
        uses: actions/setup-node@v3
        with:
          node-version: 16.x
          cache: 'npm'

      - name: Install dependencies
        run: npm ci --legacy-peer-deps

      - name: Build
        run: npm run build

      - name: Test
        run: npm run test:coverage

      - name: Lint
        run: npm run lint

      - name: Optimize SVGs
        run: |
          npm run optimize-svgs
          if git diff --quiet; then
            echo "All SVGs are optimized ✔︎"
          else
            echo "The following SVGs are not optimized:"
            git diff --name-only
            echo
            echo "Please run 'npm run optimize-svgs' and commit the changes"
            exit 1
          fi

The same workflow, on Latchkey

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

name: CI
 
on: push
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  ci:
    timeout-minutes: 30
    name: CI
    runs-on: latchkey-small
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
 
      - name: Setup Node.js 16.x
        uses: actions/setup-node@v3
        with:
          node-version: 16.x
          cache: 'npm'
 
      - name: Install dependencies
        run: npm ci --legacy-peer-deps
 
      - name: Build
        run: npm run build
 
      - name: Test
        run: npm run test:coverage
 
      - name: Lint
        run: npm run lint
 
      - name: Optimize SVGs
        run: |
          npm run optimize-svgs
          if git diff --quiet; then
            echo "All SVGs are optimized ✔︎"
          else
            echo "The following SVGs are not optimized:"
            git diff --name-only
            echo
            echo "Please run 'npm run optimize-svgs' and commit the changes"
            exit 1
          fi
 

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