dev: include Markdown link checks in the local lint suite - #25287
Merged
kumarUjjawal merged 2 commits intoSep 14, 2026
Merged
Conversation
`dev/rust_lint.sh` now runs `ci/scripts/markdown_link_check.sh` as a read-only step, after the workflow install check and before the Rust documentation build. The runner loads `LYCHEE_VERSION` from `ci/scripts/utils/tool_versions.sh` and installs that pinned version when `lychee` is missing. An already installed `lychee` is used as is, matching the runner's existing policy for other tools. The checker becomes executable so the runner can invoke it directly, as it does for every other registered script. Its body, configuration, file selection, and the GitHub workflow are unchanged, and `--write` never reaches the link check. Partial progress on apache#21048.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #25287 +/- ##
==========================================
- Coverage 81.90% 81.90% -0.01%
==========================================
Files 1134 1134
Lines 425261 425261
Branches 425261 425261
==========================================
- Hits 348325 348320 -5
- Misses 56295 56297 +2
- Partials 20641 20644 +3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
martin-g
approved these changes
Sep 14, 2026
Contributor
Author
|
Thank you @martin-g for the review. |
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.
Which issue does this PR close?
Rationale for this change
dev/rust_lint.shis the local mirror of the CI lint jobs, but it does not run the Markdown link check. CI runsci/scripts/markdown_link_check.shindev.yml. A developer can push a broken internal link after a clean local lint run and then see the failure only in CI. This PR adds the existing checker to the local suite.What changes are included in this PR?
dev/rust_lint.shrunsci/scripts/markdown_link_check.shas a read-only step, after the workflow install check and before the Rust documentation build. The--writeand--allow-dirtyflags never reach it.LYCHEE_VERSIONfromci/scripts/utils/tool_versions.shand installs that version whenlycheeis missing. An installedlycheeis used as is, which is the runner's existing policy for other tools.ci/scripts/markdown_link_check.shbecomes executable, because the runner invokes each registered script directly. The script body,lychee.toml, the file selection, and the GitHub workflow do not change.docs/source/contributor-guide/testing.mddocuments the new behavior and keeps the standalone instructions.What is the testing strategy for this PR?
lycheetriggers exactly the pinned install command, a presentlycheetriggers no install, and a checker failure stops the suite before the later steps../dev/rust_lint.shboth fail with the same exit code and name the file. After the fix, the full suite passes../dev/rust_lint.shpass on this branch withlychee0.23.0.Are there any user-facing changes?
No. Developers get the link check in the local lint suite. CI is unchanged.
🤖 Generated with Claude Code