docs(release-process): put the credit into a CHANGELOG-extracted body's source - #151
Conversation
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe change updates release documentation for workflows that build a release body from Priority: ➖ Normal Change: Other · Severity of issue fixed: Medium Merge Risk: ⚪ Minimal · up to This documentation change clarifies contributor-credit guidance without changing release behavior in this repository. No actionable merge-blocking risk remains. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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. Comment |
github-actions
Bot
added
documentation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
f693b5b to
51070a9
Compare
|
Self-review: 51070a9 Copilot could not review (its review is the quota error, on an earlier head) and CodeRabbit refused this head as rate-limited, so the author reviewed it.
Gate at this head: Assisted by claude-code:claude-opus-5-5 — Session |
…'s source Some release workflows extract the new version's CHANGELOG section with sed and publish it as the release body; netresearch/terraform-provider-ad does. That body carries exactly the @mentions the CHANGELOG entries carry, and that repository's entries credit nobody, so every release there fails release-notes-status.sh with MISSING CREDITS until the published body is edited by hand. v0.5.3 was never edited and still contains no @mention at all (checked 2026-09-22); v0.5.4 needed the hand edit the same day. The section on crediting contributors now says to write the credit into the CHANGELOG entry, so the extraction publishes it, and to add it with gh release edit for a release already out. Assisted-by: claude-code:claude-opus-5-5 Agent-Session: https://claude.ai/code/session_01GY5RqMQzgKbEvCALQ7r1ec Agent-Host: 0493f0 Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
51070a9 to
3b375a9
Compare
|
|
Self-review: 3b375a9 Re-confirming the review above for the rebased head. |
Merging this adds one paragraph to the section on crediting contributors in
references/release-process.md: where the release workflow builds the body fromCHANGELOG.md, the credit goes into the CHANGELOG entry, because the extracted body carries only the@mentionsthe entries carry.Why
netresearch/terraform-provider-ad extracts the new version's section with
sedand publishes it as the body. Its entries credit nobody, so every release there failsrelease-notes-status.shwithMISSING CREDITSuntil someone edits the published body. v0.5.3 was never edited and still contains no@mentionat all, checked on 2026-09-22. v0.5.4 needed the hand edit the same day.The paragraph says to write the credit into the entry, so the extraction publishes it, and to add it with
gh release edit --notes-filefor a release already out.CHANGELOG.mdrecords the change under Unreleased.Assisted by claude-code:claude-opus-5-5 — Session