Deploy GitBook to 9router.github.io workflow (decolua/9router)

The Deploy GitBook to 9router.github.io workflow from decolua/9router, explained and optimized by Latchkey.

What it does

This is the Deploy GitBook to 9router.github.io workflow from the decolua/9router 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: Deploy GitBook to 9router.github.io

on:
  push:
    branches: [main, master]
    paths:
      - "gitbook/**"
      - ".github/workflows/gitbook-pages.yml"
  workflow_dispatch:

concurrency:
  group: gitbook-pages
  cancel-in-progress: true

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: gitbook
    steps:
      - uses: actions/checkout@v5

      - uses: actions/setup-node@v6
        with:
          node-version: 24

      - name: Install deps
        run: npm install --no-audit --no-fund

      - name: Build static export
        run: npm run build
        env:
          NODE_ENV: production
          NEXT_PUBLIC_BASE_PATH: ""

      - name: Add .nojekyll
        run: touch out/.nojekyll

      - name: Deploy to 9router.github.io
        uses: peaceiris/actions-gh-pages@v4
        with:
          deploy_key: ${{ secrets.GH_PAGES_DEPLOY_KEY }}
          external_repository: 9router/9router.github.io
          publish_branch: main
          publish_dir: gitbook/out
          force_orphan: true
          user_name: github-actions[bot]
          user_email: github-actions[bot]@users.noreply.github.com
          commit_message: "deploy: ${{ github.sha }}"

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: Deploy GitBook to 9router.github.io
 
on:
  push:
    branches: [main, master]
    paths:
      - "gitbook/**"
      - ".github/workflows/gitbook-pages.yml"
  workflow_dispatch:
 
concurrency:
  group: gitbook-pages
  cancel-in-progress: true
 
jobs:
  build-deploy:
    timeout-minutes: 30
    runs-on: latchkey-small
    defaults:
      run:
        working-directory: gitbook
    steps:
      - uses: actions/checkout@v5
 
      - uses: actions/setup-node@v6
        with:
          cache: 'npm'
          node-version: 24
 
      - name: Install deps
        run: npm install --no-audit --no-fund
 
      - name: Build static export
        run: npm run build
        env:
          NODE_ENV: production
          NEXT_PUBLIC_BASE_PATH: ""
 
      - name: Add .nojekyll
        run: touch out/.nojekyll
 
      - name: Deploy to 9router.github.io
        uses: peaceiris/actions-gh-pages@v4
        with:
          deploy_key: ${{ secrets.GH_PAGES_DEPLOY_KEY }}
          external_repository: 9router/9router.github.io
          publish_branch: main
          publish_dir: gitbook/out
          force_orphan: true
          user_name: github-actions[bot]
          user_email: github-actions[bot]@users.noreply.github.com
          commit_message: "deploy: ${{ github.sha }}"
 

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

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