Test & Build workflow (sagalbot/vue-select)

The Test & Build workflow from sagalbot/vue-select, explained and optimized by Latchkey.

What it does

This is the Test & Build workflow from the sagalbot/vue-select 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: Test & Build
on: [pull_request]
jobs:
  test:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 12

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

      - name: Test with Coverage
        run: yarn test --coverage --coverageReporters=lcov

      - name: ESLint
        run: yarn eslint

      - name: Report Coverage
        uses: coverallsapp/github-action@master
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

  build:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 12

      - name: Install dependencies
        run: |
          yarn install --frozen-lockfile
          cd docs
          yarn install --frozen-lockfile

      - name: Build Dist
        run: yarn build

      - name: Bundlewatch
        run: npx bundlewatch

      - name: Build Docs
        run: yarn build:docs

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: Test & Build
on: [pull_request]
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          cache: 'npm'
          node-version: 12
 
      - name: Install dependencies
        run: yarn install --frozen-lockfile
 
      - name: Test with Coverage
        run: yarn test --coverage --coverageReporters=lcov
 
      - name: ESLint
        run: yarn eslint
 
      - name: Report Coverage
        uses: coverallsapp/github-action@master
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
 
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          cache: 'npm'
          node-version: 12
 
      - name: Install dependencies
        run: |
          yarn install --frozen-lockfile
          cd docs
          yarn install --frozen-lockfile
 
      - name: Build Dist
        run: yarn build
 
      - name: Bundlewatch
        run: npx bundlewatch
 
      - name: Build Docs
        run: yarn build:docs
 

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.

1 third-party action is referenced by a movable tag. Pin it 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 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