Deploy docs workflow (google/zx)

The Deploy docs workflow from google/zx, explained and optimized by Latchkey.

What it does

This is the Deploy docs workflow from the google/zx repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: Deploy docs
on:
  workflow_dispatch:
  release:
    types: [created]

concurrency:
  group: 'pages'
  cancel-in-progress: false

permissions: {}

env:
  npm_config_audit: false
  npm_config_fund: false
  npm_config_save: false
  npm_config_package_lock: false

jobs:
  deploy:
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          persist-credentials: false
          ref: main

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Install deps
        run: npm ci

      - name: Add additional deps
        run: npm i @rollup/rollup-linux-x64-gnu@4.46.4

      - name: Build docs
        run: npm run docs:build

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4.0.0
        with:
          path: 'docs/build'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

The same workflow, on Latchkey

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

name: Deploy docs
on:
  workflow_dispatch:
  release:
    types: [created]
 
concurrency:
  group: 'pages'
  cancel-in-progress: false
 
permissions: {}
 
env:
  npm_config_audit: false
  npm_config_fund: false
  npm_config_save: false
  npm_config_package_lock: false
 
jobs:
  deploy:
    timeout-minutes: 30
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: latchkey-small
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          persist-credentials: false
          ref: main
 
      - name: Setup Pages
        uses: actions/configure-pages@v5
 
      - name: Install deps
        run: npm ci
 
      - name: Add additional deps
        run: npm i @rollup/rollup-linux-x64-gnu@4.46.4
 
      - name: Build docs
        run: npm run docs:build
 
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4.0.0
        with:
          path: 'docs/build'
 
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
 

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.
• 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 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