Build workflow (redux-orm/redux-orm)

The Build workflow from redux-orm/redux-orm, explained and optimized by Latchkey.

What it does

This is the Build workflow from the redux-orm/redux-orm 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: Build

on:
    push:
        branches: [master]
    pull_request:
        branches: [master]

jobs:
    build:
        name: Test Suite
        runs-on: ubuntu-latest

        steps:
            - name: Set up Node
              uses: actions/setup-node@v1
              with:
                  node-version: 14.x

            - name: Checkout code
              uses: actions/checkout@v2

            - name: Cache dependencies
              uses: actions/cache@v2
              with:
                  path: ~/.npm
                  key: ${{ runner.OS }}-npm-${{ hashFiles('**/package-lock.json') }}
                  restore-keys: |
                      ${{ runner.OS }}-npm-
                      ${{ runner.OS }}-

            - name: Install dependencies
              run: npm ci

            - name: Build package
              run: npm run build

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: Build
 
on:
    push:
        branches: [master]
    pull_request:
        branches: [master]
 
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true
 
jobs:
    build:
        timeout-minutes: 30
        name: Test Suite
        runs-on: latchkey-small
 
        steps:
            - name: Set up Node
              uses: actions/setup-node@v1
              with:
                  cache: 'npm'
                  node-version: 14.x
 
            - name: Checkout code
              uses: actions/checkout@v2
 
            - name: Cache dependencies
              uses: actions/cache@v2
              with:
                  path: ~/.npm
                  key: ${{ runner.OS }}-npm-${{ hashFiles('**/package-lock.json') }}
                  restore-keys: |
                      ${{ runner.OS }}-npm-
                      ${{ runner.OS }}-
 
            - name: Install dependencies
              run: npm ci
 
            - name: Build package
              run: npm run build
 

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