PnP workflow (gridsome/gridsome)

The PnP workflow from gridsome/gridsome, 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: gridsome/gridsome.github/workflows/pnp.ymlLicense MITView source

What it does

This is the PnP workflow from the gridsome/gridsome 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: PnP

on:
  push:
    branches:
      - master
    paths:
      - 'yarn.lock'
      - 'gridsome/**'
      - '.github/workflows/pnp.yml'
  pull_request:
    branches:
      - master
    paths:
      - 'yarn.lock'
      - 'gridsome/**'
      - '.github/workflows/pnp.yml'

jobs:
  pnp:
    name: PnP
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Create project
        run: node scripts/pnp-test.js clone
      - name: Configure Yarn
        run: node scripts/pnp-test.js configure
      - name: Get cache directory
        working-directory: ./pnp-e2e
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-
      - name: Link packages
        run: node scripts/pnp-test.js link
      - name: Build
        run: node scripts/pnp-test.js build

The same workflow, on Latchkey

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

name: PnP
 
on:
  push:
    branches:
      - master
    paths:
      - 'yarn.lock'
      - 'gridsome/**'
      - '.github/workflows/pnp.yml'
  pull_request:
    branches:
      - master
    paths:
      - 'yarn.lock'
      - 'gridsome/**'
      - '.github/workflows/pnp.yml'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  pnp:
    timeout-minutes: 30
    name: PnP
    runs-on: latchkey-small
 
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Create project
        run: node scripts/pnp-test.js clone
      - name: Configure Yarn
        run: node scripts/pnp-test.js configure
      - name: Get cache directory
        working-directory: ./pnp-e2e
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-
      - name: Link packages
        run: node scripts/pnp-test.js link
      - name: Build
        run: node scripts/pnp-test.js build

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:

End-to-end and browser tests

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/cache