Clarify Releases page is the canonical changelog source#49
Merged
Conversation
PR #44 made the weekly-release workflow auto-generate the CHANGELOG.md entry into each release tag's commit, not into main. The in-tree CHANGELOG.md (what `git clone` shows) is therefore frozen at the last manually-touched state, while the Releases page and each release tarball's CHANGELOG.md carry the current state. The README sentence at line 232 pointed at the in-tree CHANGELOG.md as the canonical source, which is now misleading for anyone browsing the repo on GitHub. Updated to lead with the Releases page link, with the in-tarball CHANGELOG.md mentioned as the per-release snapshot.
Trivy misconfiguration findings (HIGH + CRITICAL)✅ No HIGH or CRITICAL misconfigurations detected. |
wn-hermes
approved these changes
May 22, 2026
Collaborator
wn-hermes
left a comment
There was a problem hiding this comment.
Looks safe to merge.
Reviewed scope:
- README.md only; no CODEOWNERS-sensitive paths touched.
- Single documentation wording change: points users to the GitHub Releases page as the canonical current changelog source, while keeping CHANGELOG.md as the per-release tarball snapshot.
- No code, workflow, permissions, secrets, dependency, or runtime behavior changes.
- CI is green: scan, misconfig, CodeQL, and CodeQL Analyze all passed.
No security concerns found.
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.
Summary
PR #44 made the weekly-release workflow auto-generate the CHANGELOG entry into each release tag's commit, not into
main. So:main's CHANGELOG.md → frozen at the last manually-touched state (by design — avoids needing a branch-protection bypass for the bot)The README sentence at line 232 pointed at the in-tree CHANGELOG.md as the canonical source, which is misleading for anyone browsing the repo on GitHub. This updates the sentence to lead with the Releases page.
hermes integration test note
This PR is also a real-world test of wn-hermes' review path:
README.mdonly → no CODEOWNERS hitcount: 1approvalmergeStateStatus: BLOCKEDand surface that gapTest plan
scan,misconfig,lint) green