Skip to content

docs: use absolute links in the 0.7.0 release notes - #171

Merged
SutuSebastian merged 1 commit into
mainfrom
agent/sta-436-changelog-links
Nov 16, 2026
Merged

SutuSebastian merged 1 commit into
mainfrom
agent/sta-436-changelog-links

Conversation

@SutuSebastian

Copy link
Copy Markdown
Contributor

Part of STA-436 (release 0.7.0, already published).

What

The docs deploy for the release (run 43889415212) failed Validate docs links with 132 BLUME_BROKEN_LINK errors. The docs site builds /changelog from the GitHub Release bodies, and the 0.7.0 section of CHANGELOG.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 absolute https://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.
  • Guard: internal/archtest/changelog_links_test.go fails on any relative markdown link target in CHANGELOG.md or .changeset/*.md, naming the file and line.

Evidence

  • Stripping the absolute prefix makes every changed line identical to its original, so only link targets moved.
  • The guard failed on main with 132 links, and restoring one relative link makes it fail again.
  • The site's own blume validate --strict on the rewritten section, run against a local fake release body, reports 0 errors. Putting one relative link back gives BLUME_BROKEN_LINK.
  • Whole-repo go test and golangci-lint (native and GOOS=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, then gh release edit), then re-run Deploy docs.

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.
@changeset-bot

changeset-bot Bot commented Nov 16, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: f48a9d1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Nov 16, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You'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.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c4489778-ced7-478a-8032-87fbdced0173
Commits

Reviewing files that changed from the base of the PR and between b4c3634 and f48a9d1.

Files selected for processing: 2

  • CHANGELOG.md
  • internal/archtest/changelog_links_test.go
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

@SutuSebastian
SutuSebastian merged commit fa6e131 into main Nov 16, 2026
39 of 41 checks passed
@SutuSebastian
SutuSebastian deleted the agent/sta-436-changelog-links branch November 16, 2026 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant