Build documentation workflow (MahjongRepository/mahjong)
The Build documentation workflow from MahjongRepository/mahjong, explained and optimized by Latchkey.
CI health: C - fair
Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Build documentation workflow from the MahjongRepository/mahjong 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: Build documentation
on:
push:
branches:
- master
paths:
- docs/**
- mahjong/**
- .github/workflows/publish_doc.yml
pull_request:
branches:
- master
paths:
- docs/**
- mahjong/**
- .github/workflows/publish_doc.yml
permissions:
contents: read
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
persist-credentials: false
- name: Install uv
uses: astral-sh/setup-uv@v8.1.0
- name: Install libs
run: |
uv sync --no-group dev --group docs
echo "$GITHUB_WORKSPACE/.venv/bin" >> $GITHUB_PATH
echo "VIRTUAL_ENV=$GITHUB_WORKSPACE/.venv" >> $GITHUB_ENV
- name: Build documentation
working-directory: docs
run: make clean html
- name: Deploy
uses: actions/upload-pages-artifact@v5
with:
path: docs/build/html
deploy:
if: github.event_name == 'push'
needs: build-docs
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
The same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
name: Build documentation on: push: branches: - master paths: - docs/** - mahjong/** - .github/workflows/publish_doc.yml pull_request: branches: - master paths: - docs/** - mahjong/** - .github/workflows/publish_doc.yml permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build-docs: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@v6 with: persist-credentials: false - name: Install uv uses: astral-sh/setup-uv@v8.1.0 - name: Install libs run: | uv sync --no-group dev --group docs echo "$GITHUB_WORKSPACE/.venv/bin" >> $GITHUB_PATH echo "VIRTUAL_ENV=$GITHUB_WORKSPACE/.venv" >> $GITHUB_ENV - name: Build documentation working-directory: docs run: make clean html - name: Deploy uses: actions/upload-pages-artifact@v5 with: path: docs/build/html deploy: timeout-minutes: 30 if: github.event_name == 'push' needs: build-docs permissions: pages: write id-token: write environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: latchkey-small steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v5
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 useslatchkey-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.
This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.