CI workflow (segmentio/evergreen)

The CI workflow from segmentio/evergreen, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, 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: segmentio/evergreen.github/workflows/ci.ymlLicense MITView source

What it does

This is the CI workflow from the segmentio/evergreen 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:
  pull_request:
    branches: ['master', 'v7']
  push:
    branches: ['*']
  workflow_dispatch:

jobs:
  test:
    name: Tests
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node_version: [14.18]
    steps:
      - uses: actions/checkout@master
      - uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node_version }}
      - id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"
      - uses: actions/cache@v4
        id: yarn-cache
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: yarn install --frozen-lockfile

      - name: Install codemods dependencies
        working-directory: './codemods'
        run: 'yarn install --frozen-lockfile'

      - name: Install docs dependencies
        working-directory: './docs'
        run: 'yarn install --frozen-lockfile'

      - name: Run build
        run: yarn run build

      - name: Run prettier
        run: yarn run prettier 'src/**/*.{js,ts,tsx}' --check

      - name: Run test
        run: yarn run test

      - name: Run codemods tests
        working-directory: './codemods'
        run: yarn test

      - name: Run docs lint
        working-directory: './docs'
        run: yarn run lint

      - name: Run size-limit
        run: yarn run size-limit

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:
  pull_request:
    branches: ['master', 'v7']
  push:
    branches: ['*']
  workflow_dispatch:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    name: Tests
    runs-on: latchkey-small
    strategy:
      matrix:
        node_version: [14.18]
    steps:
      - uses: actions/checkout@master
      - uses: actions/setup-node@v1
        with:
          cache: 'npm'
          node-version: ${{ matrix.node_version }}
      - id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"
      - uses: actions/cache@v4
        id: yarn-cache
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-
 
      - name: Install dependencies
        run: yarn install --frozen-lockfile
 
      - name: Install codemods dependencies
        working-directory: './codemods'
        run: 'yarn install --frozen-lockfile'
 
      - name: Install docs dependencies
        working-directory: './docs'
        run: 'yarn install --frozen-lockfile'
 
      - name: Run build
        run: yarn run build
 
      - name: Run prettier
        run: yarn run prettier 'src/**/*.{js,ts,tsx}' --check
 
      - name: Run test
        run: yarn run test
 
      - name: Run codemods tests
        working-directory: './codemods'
        run: yarn test
 
      - name: Run docs lint
        working-directory: './docs'
        run: yarn run lint
 
      - name: Run size-limit
        run: yarn run size-limit

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

actions/checkout actions/setup-node actions/cache