Fail CI on unresolved relative markdown links - #40
Merged
Conversation
markdownlint checks link syntax, not whether the target exists, so a moved file or a bad ../ path only surfaced at release time when release.sh --bundle walks the archive. Add a step to the markdownlint job that resolves every relative link in a tracked .md and fails on any that does not exist, reporting all offenders. Root-relative links resolve from the repo root as GitHub renders them; external, mailto, and anchor-only links are skipped.
mraible
enabled auto-merge (squash)
August 19, 2026 18:50
prvn
approved these changes
Aug 20, 2026
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.
markdownlint checks link syntax, not whether a target resolves. Today a broken relative link — a moved file, or a
../path that no longer resolves after content moves into areferences/subdirectory — is only caught byrelease.sh --bundle's link check, which runs at release time after the tag is published. That is a quality gate masquerading as a release gate.This adds a step to the
markdownlintjob that walks every relative link in a tracked.mdfile and fails on any that does not resolve, reporting all offenders rather than stopping at the first. Root-relative (/foo) links resolve from the repo root, as GitHub renders them; external,mailto:, and anchor-only links are skipped.Verified locally: passes on the current tree (55 files, all links resolve), and catches an injected
../does-not-exist.md— including the depth-awarereferences/case the release-time check was the only thing catching.