GitHub pages workflow (openwrt/luci)

The GitHub pages workflow from openwrt/luci, explained and optimized by Latchkey.

What it does

This is the GitHub pages workflow from the openwrt/luci 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: GitHub pages

on:
  push:
    branches:
      - master
    paths:
      # One day we might include all htdocs folders:
      # - '**/htdocs/**'
      # Until then, follow jsdoc.conf.json:source directive
      - 'modules/luci-base/htdocs/luci-static/resources/**'
      - 'docs/**'

permissions:
  contents: read
  pages: write
  id-token: write

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

jobs:
  build:
    if: endsWith(github.repository, 'luci')
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Install
        run: npm install

      - name: Build
        run: npm run doc

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

      - 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: GitHub pages
 
on:
  push:
    branches:
      - master
    paths:
      # One day we might include all htdocs folders:
      # - '**/htdocs/**'
      # Until then, follow jsdoc.conf.json:source directive
      - 'modules/luci-base/htdocs/luci-static/resources/**'
      - 'docs/**'
 
permissions:
  contents: read
  pages: write
  id-token: write
 
concurrency:
  group: "pages"
  cancel-in-progress: false
 
jobs:
  build:
    timeout-minutes: 30
    if: endsWith(github.repository, 'luci')
    runs-on: latchkey-small
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
 
      - name: Install
        run: npm install
 
      - name: Build
        run: npm run doc
 
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: ./docs/
 
      - 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