Documentation workflow (chancejs/chancejs)

The Documentation workflow from chancejs/chancejs, explained and optimized by Latchkey.

What it does

This is the Documentation workflow from the chancejs/chancejs 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: Documentation

on:
  pull_request:
    branches:
      - master
    paths:
      - 'docs/**/*'
  push:
    branches:
      - master
    paths:
      - 'docs/**/*'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 16
      - name: build and deploy
        if: github.event_name == 'pull_request' && github.event.pull_request.merged == 'true'
        run: |
          yarn
          yarn docs
          yarn docs:publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_REPO: chancejs/chancejs
          GIT_NAME: Travis CI
          GIT_EMAIL: mail@victorquinn.ocm
          GIT_SOURCE: _docpress

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: Documentation
 
on:
  pull_request:
    branches:
      - master
    paths:
      - 'docs/**/*'
  push:
    branches:
      - master
    paths:
      - 'docs/**/*'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          cache: 'npm'
          node-version: 16
      - name: build and deploy
        if: github.event_name == 'pull_request' && github.event.pull_request.merged == 'true'
        run: |
          yarn
          yarn docs
          yarn docs:publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_REPO: chancejs/chancejs
          GIT_NAME: Travis CI
          GIT_EMAIL: mail@victorquinn.ocm
          GIT_SOURCE: _docpress
 

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