Skip to content

ci(docs): make nav-integrity's mkdocs build --strict #2122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdfinst merged 1 commit into from
Sep 4, 2026
+14 −10
Merged

ci(docs): make nav-integrity's mkdocs build --strict #2122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions .github/workflows/link-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:

- uses: actions/setup-python@v7
with:
python-version: "3.x"
python-version: '3.x'

- name: Install MkDocs dependencies
run: pip install -r requirements-docs.txt
Expand All @@ -47,13 +47,23 @@ jobs:
run: bash scripts/assemble-docs.sh

- name: Build site
run: mkdocs build --site-dir /tmp/site
run:
mkdocs build --strict --site-dir /tmp/site 2>&1 | tee
/tmp/mkdocs-build.log

# Same nav-integrity assertion the local gate runs (scripts/ci-local.sh's
# chk_nav_integrity), kept in one script so CI and pre-push can't drift.
- name: Assert every nav entry resolves to a file
run: python3 scripts/check_nav_integrity.py

- name: Report assembled-tree broken-link count
if: always()
run: |
count=$(grep -c "target .* is not found among documentation files" /tmp/mkdocs-build.log || true)
echo "Broken links against the assembled docs tree: ${count:-0}"
if [ "${count:-0}" -gt 0 ]; then
echo "::warning::${count} broken link(s) found against the assembled docs site tree — see the 'Build site' step log above for the full list."
fi
# Validates relative links and anchors inside the documentation bodies. Offline:
# only local file links are resolved, so external link rot never flakes the gate.
body-links:
Expand All @@ -66,13 +76,7 @@ jobs:
uses: lycheeverse/lychee-action@v2
with:
args: >-
--offline
--no-progress
README.md
GETTING-STARTED.md
CONTRIBUTING.md
CHANGELOG.md
docs/**/*.md
plugins/dev-team/README.md
--offline --no-progress README.md GETTING-STARTED.md CONTRIBUTING.md
CHANGELOG.md docs/**/*.md plugins/dev-team/README.md
plugins/dev-team/docs/**/*.md
fail: true
Loading