fix(changelog): preserve custom release-note sections like "What's New"#87
Merged
fix(changelog): preserve custom release-note sections like "What's New"#87
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the release-notes parsing and changelog rendering pipeline so that custom top-level (##) sections in GitHub Release Notes (e.g., “What’s New”) are preserved in generated/updated CHANGELOG.md, including better handling of typographic heading variants.
Changes:
- Extend
parseReleaseNotesto normalize “What’s Changed” / “Full Changelog” heading matching and to preserve custom##sections (deduped, order preserved). - Update release-notes fallback generation to proceed when custom sections exist even if no PR items are parsed.
- Add tests covering custom-section extraction/deduplication and rendering when there are no parsed items.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/utils/release.ts |
Normalizes heading matching and preserves/dedupes custom ## sections from release notes. |
src/utils/llm-output.ts |
Allows release-notes-based output when additional sections exist without parsed items. |
tests/utils/release.test.ts |
Adds coverage for typographic headings and custom-section preservation/deduplication. |
tests/utils/llm-output.test.ts |
Adds coverage for rendering custom sections when no PR items are parsed. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Close #86
Summary
Preserve custom release-note sections like "What's New"
Description
CHANGELOG.md(including ## What’s New).What's Changed/What’s Changedand Full Changelog variants.