Improve changelog rendering format#2169
Merged
Merged
Conversation
Group changelog entries by change type, add a fallback section for unknown types, and re-render CHANGELOG.md. Also convert legacy reStructuredText-style links in historical change fragments to Markdown.
Alan4506
reviewed
May 6, 2026
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
Updates the changelog template to render entries grouped by change type:
This also removes the old
type:category:prefix from rendered entries and converts a few historical reStructuredText-style links in change fragments to Markdown links.CHANGELOG.mdis included in this PR so reviewers can see the rendered output directly in GitHub.Testing
jmeslog render -t changelogCHANGELOG.mdmatches the template outputShowcase
Before
After
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.