Docs

feat(runner): isolate structured workflows in one-attempt Kubernetes … #552

	name: Docs

	on:
	push:
	branches:
	- main
	paths:
	- "docs/**"
	- "mkdocs.yml"
	- "CHANGELOG.md"
	- ".github/workflows/docs.yml"
	# Run on every PR (no paths filter) so code-side changes that invalidate
	# doc facts: Renovate Bun bumps, src/ refactors that shift cited line
	# numbers, .tool-versions updates: still trip the docs gate. The
	# `Deploy to GitHub Pages` step further down stays guarded by
	# `if: github.event_name == 'push' \|\| github.event_name == 'workflow_dispatch'`,
	# so PRs validate but never publish.
	pull_request:
	workflow_dispatch:

	permissions:
	contents: write

	concurrency:
	group: docs-${{ github.ref }}
	cancel-in-progress: false

	jobs:
	build:
	runs-on: ubuntu-24.04
	steps:
	- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
	with:
	fetch-depth: 0

	- uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0
	with:
	bun-version-file: .tool-versions

	- name: Verify docs version pins
	run: bun run scripts/check-docs-versions.ts

	- name: Verify docs src citations
	run: bun run scripts/check-docs-citations.ts

	- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
	with:
	python-version: "3.x"
	cache: pip
	cache-dependency-path: docs/requirements.txt

	- name: Install dependencies
	run: pip install -r docs/requirements.txt

	- name: Build (strict)
	run: mkdocs build --strict

	- name: Deploy to GitHub Pages
	if: github.event_name == 'push' \|\| github.event_name == 'workflow_dispatch'
	run: mkdocs gh-deploy --force

Navigation Menu