Repository navigation
docs: use absolute links in the 0.7.0 release notes - #171
Conversation
The docs site renders GitHub Release bodies under /changelog, where a repo-relative link resolves against that route. All 132 links in the 0.7.0 section now point at the repository files on main, with the anchors unchanged; an archtest guards CHANGELOG.md and pending changesets.
|
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 59 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
Part of STA-436 (release 0.7.0, already published).
What
The docs deploy for the release (run 43889415212) failed
Validate docs linkswith 132BLUME_BROKEN_LINKerrors. The docs site builds/changelogfrom the GitHub Release bodies, and the 0.7.0 section ofCHANGELOG.md, which is that body, used repo-relative links (docs/manual.md#…). Those resolve under/changelog/and also break on the GitHub Release page.CHANGELOG.md: every link in the 0.7.0 section now uses the absolutehttps://github.com/stainless-code/verdict/blob/main/<path>#<anchor>form the rest of the site uses. That's 132 links, with byte-identical anchors. Older sections are untouched, and none of them had relative links.internal/archtest/changelog_links_test.gofails on any relative markdown link target inCHANGELOG.mdor.changeset/*.md, naming the file and line.Evidence
blume validate --stricton the rewritten section, run against a local fake release body, reports 0 errors. Putting one relative link back givesBLUME_BROKEN_LINK.go testand golangci-lint (native andGOOS=windows) pass.No changeset: this changes docs and tests only.
After merge: re-publish the v0.7.0 Release body from the corrected changelog (
scripts/release-notes.mjs 0.7.0, thengh release edit), then re-run Deploy docs.