Github Actions workflow (pegjs/pegjs)

The Github Actions workflow from pegjs/pegjs, 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: pegjs/pegjs.github/workflows/main.ymlLicense MITView source

What it does

This is the Github Actions workflow from the pegjs/pegjs 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: Github Actions

on: [ push, pull_request ]

jobs:

  lint:
    name: Lint

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@master

    - name: Install Node.js
      uses: actions/setup-node@master
      with:
        node-version: 10.x

    - name: Install Yarn
      run: npm install --global yarn

    - name: Install dependencies
      run: yarn --ignore-engines

    - name: Lint JavaScript files using ESLint
      run: yarn lint

  ci:
    name: Test

    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        node-version: [ 8.x, 10.x, 12.x ]

    steps:
    - uses: actions/checkout@master

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

    - name: Install Yarn
      run: npm install --global yarn

    - name: Install dependencies
      run: yarn --ignore-engines

    - name: Run tests
      run: yarn test

    - name: Publish code coverage results
      run: yarn coverage
      env:
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  cd:
    name: Publish
    needs: [ lint, ci ]

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@master

    - name: Install Node.js
      uses: actions/setup-node@master
      with:
        node-version: 10.x

    - name: Install Yarn
      run: npm install --global yarn

    - name: Install dependencies
      run: yarn --ignore-engines

    - name: 'Build "pegjs/dist/*.js" files'
      run: yarn build-dist

    - name: Publish pegjs@dev to NPM
      run: node tools/publish-dev
      env:
        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

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: Github Actions
 
on: [ push, pull_request ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
 
  lint:
    timeout-minutes: 30
    name: Lint
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@master
 
    - name: Install Node.js
      uses: actions/setup-node@master
      with:
        cache: 'npm'
        node-version: 10.x
 
    - name: Install Yarn
      run: npm install --global yarn
 
    - name: Install dependencies
      run: yarn --ignore-engines
 
    - name: Lint JavaScript files using ESLint
      run: yarn lint
 
  ci:
    timeout-minutes: 30
    name: Test
 
    runs-on: latchkey-small
 
    strategy:
      fail-fast: false
      matrix:
        node-version: [ 8.x, 10.x, 12.x ]
 
    steps:
    - uses: actions/checkout@master
 
    - name: Install Node.js
      uses: actions/setup-node@master
      with:
        cache: 'npm'
        node-version: ${{ matrix.node-version }}
 
    - name: Install Yarn
      run: npm install --global yarn
 
    - name: Install dependencies
      run: yarn --ignore-engines
 
    - name: Run tests
      run: yarn test
 
    - name: Publish code coverage results
      run: yarn coverage
      env:
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
  cd:
    timeout-minutes: 30
    name: Publish
    needs: [ lint, ci ]
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@master
 
    - name: Install Node.js
      uses: actions/setup-node@master
      with:
        cache: 'npm'
        node-version: 10.x
 
    - name: Install Yarn
      run: npm install --global yarn
 
    - name: Install dependencies
      run: yarn --ignore-engines
 
    - name: 'Build "pegjs/dist/*.js" files'
      run: yarn build-dist
 
    - name: Publish pegjs@dev to NPM
      run: node tools/publish-dev
      env:
        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

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