Repository navigation
Docs: resolve the changelog's links from the repository root - #46
Merged
Merged
Conversation
The manual includes CHANGELOG.md from docs/changelog.md without saying where its links start, so the first fragment to link a page failed the documentation build on the rolling release pull request, and would have failed the release. A test now checks fragments' links, so a bad one fails on the pull request that adds it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
jtravs
added
documentation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Documentation build overview
80 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Fixes the docs failure on the rolling release PR #42, build 35655341:
What changed
docs/changelog.mdincludes the changelog with:relative-docs: docs/, as solprop's does. I missed this when porting the fragment workflow in Collect release notes from fragments in a rolling draft pull request #38.tests/test_release_metadata.pychecks that links inCHANGELOG.mdand in fragments point to a real page underdocs/, so a bad one fails on the PR that adds it rather than at release.changelog.d/README.mdstates the rule, and there's a fragment for the fix.Why it wasn't seen earlier
A fragment reaches the manual only when the release PR collects it, and every earlier #42 build was killed or cancelled before finishing (#40). Left alone, it would have failed
poe checkat the next release.Verification
developers/releasing.html.REGISTER.mdfails the new test.uv run poe checkpassed, with 21540 passed, 1 skipped and 100% coverage. The public-wording scan shows no new hits.🤖 Generated with Claude Code