CI workflow (cyrus-and/chrome-remote-interface)

The CI workflow from cyrus-and/chrome-remote-interface, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get 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: cyrus-and/chrome-remote-interface.github/workflows/ci.ymlLicense MITView source

What it does

This is the CI workflow from the cyrus-and/chrome-remote-interface 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
  workflow_dispatch:
jobs:
  Tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Dump Chrome version
        run: |
          "$CHROME_BIN" --version
      - name: Dump Node.js version
        run: |
          node --version
      - name: Dump NPM version
        run: |
          npm --version
      - name: Install dependencies
        run: |
          npm install
      - name: Start headless Chrome
        run: |
          $CHROME_BIN \
              --disable-extensions \
              --disable-gpu \
              --headless \
              --no-first-run \
              --no-sandbox \
              --remote-debugging-port=9222 \
              --user-data-dir="$(mktemp -d)" \
              about:blank &
      - name: Wait for Chrome to start listening
        run: |
          while ! curl --silent --fail http://localhost:9222; do sleep 1; done
      - name: Run tests
        run: |
          npm test

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: CI
on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
  workflow_dispatch:
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  Tests:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v2
      - name: Dump Chrome version
        run: |
          "$CHROME_BIN" --version
      - name: Dump Node.js version
        run: |
          node --version
      - name: Dump NPM version
        run: |
          npm --version
      - name: Install dependencies
        run: |
          npm install
      - name: Start headless Chrome
        run: |
          $CHROME_BIN \
              --disable-extensions \
              --disable-gpu \
              --headless \
              --no-first-run \
              --no-sandbox \
              --remote-debugging-port=9222 \
              --user-data-dir="$(mktemp -d)" \
              about:blank &
      - name: Wait for Chrome to start listening
        run: |
          while ! curl --silent --fail http://localhost:9222; do sleep 1; done
      - name: Run tests
        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.
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
Network fetches

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