Pull request workflow workflow (vuejs/vuepress)

The Pull request workflow workflow from vuejs/vuepress, explained and optimized by Latchkey.

What it does

This is the Pull request workflow workflow from the vuejs/vuepress 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: Pull request workflow

on:
  pull_request:

jobs:
  pr:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '14'
          check-latest: true
      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v2
        with:
          path: '**/node_modules'
          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}

      - name: Install dependencies
        if: steps.yarn-cache.outputs.cache-hit != 'true'
        run: yarn

      - name: Run tsc
        run: yarn tsc

      - name: Run unit tests
        run: yarn test

      - name: Check linter
        run: yarn lint

      - name: Check markdown linter
        run: yarn workspace docs lint-md

      - name: Build vuepress
        run: yarn build 

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: Pull request workflow on:  pull_request: concurrency:  group: ${{ github.workflow }}-${{ github.ref }}  cancel-in-progress: true jobs:  pr:    timeout-minutes: 30    runs-on: latchkey-small    steps:      - uses: actions/checkout@v2      - uses: actions/setup-node@v2        with:          cache: 'npm'          node-version: '14'          check-latest: true      - name: Get yarn cache directory path        id: yarn-cache-dir-path        run: echo "::set-output name=dir::$(yarn cache dir)"       - uses: actions/cache@v2        with:          path: '**/node_modules'          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}       - name: Install dependencies        if: steps.yarn-cache.outputs.cache-hit != 'true'        run: yarn       - name: Run tsc        run: yarn tsc       - name: Run unit tests        run: yarn test       - name: Check linter        run: yarn lint       - name: Check markdown linter        run: yarn workspace docs lint-md       - name: Build vuepress        run: yarn 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.
• 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.

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

Frequently asked questions

References

• Node.js documentation
• npm CLI documentation
• GitHub Actions documentation