Pages workflow (XiaoLuoLYG/GOD)

The Pages workflow from XiaoLuoLYG/GOD, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get caching, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: XiaoLuoLYG/GOD.github/workflows/pages.ymlLicense Apache-2.0View source

What it does

This is the Pages workflow from the XiaoLuoLYG/GOD 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

workflow (.yml)

name: Pages

on:
  push:
    branches: [main]
  workflow_dispatch:

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

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

jobs:
  deploy:
    name: Build and deploy public pages
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.11"

      - name: Install developer docs dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -r docs/developer/requirements.txt

      - name: Build public pages
        run: |
          set -euo pipefail
          mkdir -p _site
          cp -R docs/site/. _site/
          sphinx-build -W -b html docs/developer _site/developer

      - name: Guard release asset boundary
        run: |
          set -euo pipefail
          banned="$(
            find _site/public-data \( \
              -path '*/downloads/*' -o \
              -path '*/map-packs/*/assets/*' -o \
              -path '*/map-packs/*/characters/*' -o \
              -path '*/map-packs/*/location-assets/*' -o \
              -name '*.zip' \
            \) -print 2>/dev/null | head -50
          )"
          if [[ -n "${banned}" ]]; then
            echo "Large public pack assets must be uploaded as GitHub Release assets, not deployed from Git:"
            echo "${banned}"
            exit 1
          fi

      - name: Configure Pages
        uses: actions/configure-pages@v6

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

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

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: Pages
 
on:
  push:
    branches: [main]
  workflow_dispatch:
 
permissions:
  contents: read
  pages: write
  id-token: write
 
concurrency:
  group: pages
  cancel-in-progress: false
 
jobs:
  deploy:
    timeout-minutes: 30
    name: Build and deploy public pages
    runs-on: latchkey-small
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6
 
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: "3.11"
 
      - name: Install developer docs dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -r docs/developer/requirements.txt
 
      - name: Build public pages
        run: |
          set -euo pipefail
          mkdir -p _site
          cp -R docs/site/. _site/
          sphinx-build -W -b html docs/developer _site/developer
 
      - name: Guard release asset boundary
        run: |
          set -euo pipefail
          banned="$(
            find _site/public-data \( \
              -path '*/downloads/*' -o \
              -path '*/map-packs/*/assets/*' -o \
              -path '*/map-packs/*/characters/*' -o \
              -path '*/map-packs/*/location-assets/*' -o \
              -name '*.zip' \
            \) -print 2>/dev/null | head -50
          )"
          if [[ -n "${banned}" ]]; then
            echo "Large public pack assets must be uploaded as GitHub Release assets, not deployed from Git:"
            echo "${banned}"
            exit 1
          fi
 
      - name: Configure Pages
        uses: actions/configure-pages@v6
 
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: _site
 
      - 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.
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.

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

actions/checkout actions/setup-python actions/upload-pages-artifact actions/deploy-pages