CI workflow (rsmbl/Resemble.js)

The CI workflow from rsmbl/Resemble.js, explained and optimized by Latchkey.

CI health: F - at risk

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: rsmbl/Resemble.js.github/workflows/CI.ymlLicense MITView source

What it does

This is the CI workflow from the rsmbl/Resemble.js 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: [master]
    pull_request:
        branches: [master]

jobs:
    codacy-analysis-cli:
        name: Codacy Analysis CLI
        runs-on: ubuntu-latest
        steps:
            - name: Checkout code
              uses: actions/checkout@main

            - name: Run Codacy Analysis CLI
              uses: codacy/codacy-analysis-cli-action@master

    coverage:
        runs-on: windows-latest
        name: codacy-coverage-reporter
        steps:
            - uses: actions/checkout@v2

            - name: Set up Node.js
              uses: actions/setup-node@v1
              with:
                  node-version: 18

            - name: Install Node.js dependencies
              run: npm ci

            - name: Test
              run: npm run test:coverage

            - name: Run codacy-coverage-reporter
              uses: codacy/codacy-coverage-reporter-action@v1
              with:
                  project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
                  coverage-reports: coverage/lcov.info

    lint:
        name: Run linters
        runs-on: ubuntu-latest

        steps:
            - uses: actions/checkout@v2

            - name: Set up Node.js
              uses: actions/setup-node@v1
              with:
                  node-version: 18

            - name: Install Node.js dependencies
              run: npm ci --ignore-scripts

            - name: Run linters
              uses: wearerequired/lint-action@v1
              with:
                  auto_fix: false
                  eslint: true
                  prettier: false

    build:
        runs-on: windows-latest

        strategy:
            matrix:
                node-version: [14.x, 18.x]
                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/

        steps:
            - uses: actions/checkout@v2

            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v2
              with:
                  node-version: ${{ matrix.node-version }}

            - name: Install
              run: npm ci

            - name: Test
              run: npm test

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: CI
 
on:
    push:
        branches: [master]
    pull_request:
        branches: [master]
 
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true
 
jobs:
    codacy-analysis-cli:
        timeout-minutes: 30
        name: Codacy Analysis CLI
        runs-on: latchkey-small
        steps:
            - name: Checkout code
              uses: actions/checkout@main
 
            - name: Run Codacy Analysis CLI
              uses: codacy/codacy-analysis-cli-action@master
 
    coverage:
        timeout-minutes: 30
        runs-on: windows-latest
        name: codacy-coverage-reporter
        steps:
            - uses: actions/checkout@v2
 
            - name: Set up Node.js
              uses: actions/setup-node@v1
              with:
                  cache: 'npm'
                  node-version: 18
 
            - name: Install Node.js dependencies
              run: npm ci
 
            - name: Test
              run: npm run test:coverage
 
            - name: Run codacy-coverage-reporter
              uses: codacy/codacy-coverage-reporter-action@v1
              with:
                  project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
                  coverage-reports: coverage/lcov.info
 
    lint:
        timeout-minutes: 30
        name: Run linters
        runs-on: latchkey-small
 
        steps:
            - uses: actions/checkout@v2
 
            - name: Set up Node.js
              uses: actions/setup-node@v1
              with:
                  cache: 'npm'
                  node-version: 18
 
            - name: Install Node.js dependencies
              run: npm ci --ignore-scripts
 
            - name: Run linters
              uses: wearerequired/lint-action@v1
              with:
                  auto_fix: false
                  eslint: true
                  prettier: false
 
    build:
        timeout-minutes: 30
        runs-on: windows-latest
 
        strategy:
            matrix:
                node-version: [14.x, 18.x]
                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
        steps:
            - uses: actions/checkout@v2
 
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v2
              with:
                  cache: 'npm'
                  node-version: ${{ matrix.node-version }}
 
            - name: Install
              run: npm ci
 
            - name: Test
              run: npm test

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.

3 third-party actions are referenced by a movable tag. Pin them to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

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 4 jobs (5 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