Deploy docs workflow (chartjs/Chart.js)

The Deploy docs workflow from chartjs/Chart.js, explained and optimized by Latchkey.

What it does

This is the Deploy docs workflow from the chartjs/Chart.js 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

# This workflow publishes new documentation to https://chartjs.org/docs/master after every commit
name: Deploy docs

on:
  push:
    branches:
      - master

permissions:
  contents: read

jobs:
  correct_repository:
    permissions:
      contents: none
    runs-on: ubuntu-latest
    steps:
      - name: fail on fork
        if: github.repository_owner != 'chartjs'
        run: exit 1

  build:
    needs: correct_repository
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: pnpm/action-setup@v4.2.0
      - name: Use Node.js
        uses: actions/setup-node@v6
        with:
          node-version: 16
          cache: pnpm
      - name: Package & Deploy Docs
        run: |
          pnpm install
          pnpm run build
          ./scripts/docs-config.sh "master"
          pnpm run docs
          pnpm pack
          ./scripts/deploy-docs.sh "master"
        env:
          GITHUB_TOKEN: ${{ secrets.GH_AUTH_TOKEN }}
          GH_AUTH_EMAIL: ${{ secrets.GH_AUTH_EMAIL }}

The same workflow, on Latchkey

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

# This workflow publishes new documentation to https://chartjs.org/docs/master after every commit
name: Deploy docs
 
on:
  push:
    branches:
      - master
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  correct_repository:
    timeout-minutes: 30
    permissions:
      contents: none
    runs-on: latchkey-small
    steps:
      - name: fail on fork
        if: github.repository_owner != 'chartjs'
        run: exit 1
 
  build:
    timeout-minutes: 30
    needs: correct_repository
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v6
      - uses: pnpm/action-setup@v4.2.0
      - name: Use Node.js
        uses: actions/setup-node@v6
        with:
          node-version: 16
          cache: pnpm
      - name: Package & Deploy Docs
        run: |
          pnpm install
          pnpm run build
          ./scripts/docs-config.sh "master"
          pnpm run docs
          pnpm pack
          ./scripts/deploy-docs.sh "master"
        env:
          GITHUB_TOKEN: ${{ secrets.GH_AUTH_TOKEN }}
          GH_AUTH_EMAIL: ${{ secrets.GH_AUTH_EMAIL }}
 

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.

1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

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 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow