All the CI workflow (swapagarwal/swag-for-dev)

The All the CI workflow from swapagarwal/swag-for-dev, explained and optimized by Latchkey.

What it does

This is the All the CI workflow from the swapagarwal/swag-for-dev repository, a real project running GitHub Actions. It is shown here with attribution under its CC0-1.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: All the CI

on:
  push:
    branches:
      - master
  pull_request: {}

jobs:
  unit:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: actions/cache@v2.1.6
      with:
        path: ~/.npm
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-
    - name: Read .nvmrc
      run: echo "##[set-output name=nvmrc;]$(cat .nvmrc)"
      id: nvm
    - name: Setup Node
      uses: actions/setup-node@v2.4.0
      with:
        node-version: ${{ steps.nvm.outputs.nvmrc }}
    - run: npm ci

    - run: npm run test

  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: actions/cache@v2.1.6
      with:
        path: ~/.npm
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-
    - name: Read .nvmrc
      run: echo "##[set-output name=nvmrc;]$(cat .nvmrc)"
      id: nvm
    - name: Setup Node
      uses: actions/setup-node@v2.4.0
      with:
        node-version: ${{ steps.nvm.outputs.nvmrc }}
    - run: npm ci

    - run: npm run lint

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

name: All the CI
 
on:
  push:
    branches:
      - master
  pull_request: {}
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  unit:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
    - uses: actions/checkout@v2
 
    - uses: actions/cache@v2.1.6
      with:
        path: ~/.npm
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-
    - name: Read .nvmrc
      run: echo "##[set-output name=nvmrc;]$(cat .nvmrc)"
      id: nvm
    - name: Setup Node
      uses: actions/setup-node@v2.4.0
      with:
        cache: 'npm'
        node-version: ${{ steps.nvm.outputs.nvmrc }}
    - run: npm ci
 
    - run: npm run test
 
  lint:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
    - uses: actions/checkout@v2
 
    - uses: actions/cache@v2.1.6
      with:
        path: ~/.npm
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-
    - name: Read .nvmrc
      run: echo "##[set-output name=nvmrc;]$(cat .nvmrc)"
      id: nvm
    - name: Setup Node
      uses: actions/setup-node@v2.4.0
      with:
        cache: 'npm'
        node-version: ${{ steps.nvm.outputs.nvmrc }}
    - run: npm ci
 
    - run: npm run lint
 

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.
• Cache dependency installs on the setup step so they are served from cache.
• 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 per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow