ci(docs): make nav-integrity's mkdocs build --strict - #2122
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
body-links(lychee) validates the raw repo tree, not the assembled MkDocs site tree that actually gets published, so a link that 404s on the live site could still pass CI.nav-integrity'smkdocs buildnow runs with--strict, which aborts on any WARNING-level build log line — including a broken body link or drifted anchor against the assembled tree. Safe to make blocking now that docs: 60 pre-existing broken links/anchors found against the assembled site tree #2118 cleared the pre-existing backlog (merged in fix(docs): fix 72 broken links/anchors against the assembled site tree #2121).workflowOAuth scope needed to push.github/workflows/*.ymlchanges itself — verified equivalent to the diff prepared in ci: make nav-integrity's mkdocs build --strict (#2118 follow-up, blocked on workflow scope) #2120: same resolvedrun:command,mkdocs build --strictstill exits 0 clean andtests/repo/test_required_status_checks.pystill passes.Test Plan
bash scripts/assemble-docs.sh && mkdocs build --strict --site-dir /tmp/site— exit 0, cleanpython3 -m pytest tests/repo/test_required_status_checks.py -q— passes (new step on an existing job, no new required-check registration needed)--strictwith exit 1Closes #2120
🤖 Generated with Claude Code
https://claude.ai/code/session_01URnco7Z5bKfKBMdNiZGQL4
Generated by Claude Code