Repository navigation
Add GitHub workflow to check Markdown links - #1201
Open
radoslawszulgo wants to merge 11 commits into
Open
radoslawszulgo wants to merge 11 commits into
radoslawszulgo wants to merge 11 commits into
Conversation
Run byrnereese/github-action-mkdocs-link-check on every pull request to catch broken internal and external links in docs/. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Use synchronous mode so a remote timeout is reported as a broken link instead of crashing the async checker. Skip relative links, which the checker resolves against rendered page URLs rather than source files, and percona.community, whose TLD the checker's URL regex rejects. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The install page linked to upgrade-from-70.md, which no longer exists. Point it to the 8.0 to 8.3 upgrade guide instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The link-check action skips relative links because it resolves them incorrectly. Run mkdocs build --strict so links to missing pages or images fail the PR instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Set MkDocs anchor validation to warn so the strict build on PRs fails on links to missing headings. Fix the two typo anchors it found. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Azure pricing page often responds slower than the checker's fixed 3s timeout, which makes the check flaky. Also rename the job and step to describe what they check. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The old docs.mongodb.com URL returns 404. Point it to the current MongoDB manual page and anchor. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
mkdocs-link-check was flaky: it has a fixed 3s timeout, treats 403 and 429 responses as broken, and its retry accepts 404 pages. lychee uses a 30s timeout, 5 retries, and the GitHub token to avoid github.com rate limits. Skip localhost examples, the Azure pricing page, the Entra sign-in portal, and macro-built VEX URLs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
lychee's 30s timeout and retries handle the slow Azure pricing page, so it no longer needs to be skipped. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully deployed
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
2 participants
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.
What
Adds
.github/workflows/link-check.yml, which runs mkdocs-link-check (byrnereese/github-action-mkdocs-link-check@1.0) on every pull request.Why
To catch broken internal and external links in
docs/before they get merged.Notes for reviewers
docs/, including subfolders. Recursion is off by default in the action, so it is turned on withrecurse: 'yes'.'yes'. A value of'true'does nothing.excludespattern.synchronous: 'yes'. It is slower but more reliable.🤖 Generated with Claude Code