feat(release): use extracted CHANGELOG notes instead of --generate-notes - #85
Conversation
PUBLISH mode's gh release create used GitHub's own --generate-notes auto-summary, which diverges from the curated notes semantic-release already wrote to CHANGELOG.md during PREPARE mode (CodeRabbit catch, task_1788457898992, deferred to a fast-follow). scripts/extract-release-notes.mjs pulls the released version's section out of CHANGELOG.md and FAILS OPEN by design (boss's requirement): any read/parse failure or empty section exits 1, and the workflow step falls back to --generate-notes rather than ever blocking a publish over a cosmetic notes gap. Byte-identical to the canary (node-datto-rmm#77, murph-reviewed): the regex bug murph caught there (single-# minor/major headings not recognized as section boundaries) is already fixed in this version -- re-validated against this repo's own real CHANGELOG.md before pushing.
|
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 10 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe pull request adds a CLI to extract version sections from ChangesRelease notes workflow
Estimated code review effort: 3 (Moderate) | ~20 minutes Merge Risk: ⚪ Minimal · up to Release publishing now uses matching changelog notes when available and retains generated GitHub notes as a fallback, with no current merge-blocking risk identified. Sequence Diagram(s)sequenceDiagram
participant ReleaseWorkflow
participant ExtractReleaseNotes
participant CHANGELOG
participant GitHubRelease
ReleaseWorkflow->>ExtractReleaseNotes: extract notes for release version
ExtractReleaseNotes->>CHANGELOG: read CHANGELOG.md
CHANGELOG-->>ExtractReleaseNotes: changelog content
ExtractReleaseNotes-->>ReleaseWorkflow: notes or extraction error
ReleaseWorkflow->>GitHubRelease: create release with notes file or generated notes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
asachs01
left a comment
asachs01
left a comment
There was a problem hiding this comment.
Reviewed on behalf of murph (formal approval blocked -- shared wyre-agent-fleet identity can't approve its own PR, same wall as usual).
Confirmed byte-identical (diff-verified, not just visually) to the murph-reviewed canary WYRE-AI/node-datto-rmm#77, which included a real content-correctness fix I found and independently re-verified: the CHANGELOG heading regex now matches both ## (patch) and # (minor/major) headings semantic-release emits, fixing a bug where a minor/major release's notes either failed to extract or bled the wrong section's content (including BREAKING CHANGES) into an adjacent patch's release notes.
LGTM. Needs an actual approving click from Aaron -- this repo's branch protection requires 1 distinct-identity approval and no fleet agent can satisfy that here.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
1 participant
Identical pass following the canary (WYRE-AI/node-datto-rmm#77, murph-reviewed and merged) for task_1788458278413_29823067.
Adds scripts/extract-release-notes.mjs and rewires PUBLISH mode's
gh release createto use--notes-filefrom it instead of--generate-notes, falling back to--generate-noteson any read/parse failure or empty output (fail-open, boss's requirement). Byte-identical diff to the canary, which includes the fix for the single-# minor/major heading bug murph caught in review.Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Summary by CodeRabbit