feat(parser-emoji): render descriptive changelog labels - #1468
Open
floze-the-genius wants to merge 2 commits into
Open
feat(parser-emoji): render descriptive changelog labels#1468floze-the-genius wants to merge 2 commits into
floze-the-genius wants to merge 2 commits into
Conversation
Cover opt-in descriptive emoji headings, tag-free summaries, and parsed scopes. Implements: python-semantic-release#1409 Signed-off-by: Floze <88098863+floze-the-genius@users.noreply.github.com>
Map built-in shortcode tags to descriptive Unicode changelog section labels. Enable this mapping only through the opt-in parser setting. Remove the classified tag from commit summaries in that mode. Keep custom tags and default output unchanged. Implements: python-semantic-release#1409 Signed-off-by: Floze <88098863+floze-the-genius@users.noreply.github.com>
Author
|
Rewrote the two commit messages to satisfy the repository’s 100-character body-line limit. The code/documentation diff is byte-for-byte unchanged; only commit metadata changed. All commit-message lines are now at most 79 characters, and both commits retain their Conventional Commit subjects, issue references, and DCO sign-offs. |
floze-the-genius
force-pushed
the
feat/1409-render-emoji-changelog
branch
from
July 20, 2026 11:48
21cf5e0 to
6c97882
Compare
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
1 participant
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.
Purpose
Implements #1409 by adding an opt-in
commit_parser_options.render_emojisetting for the built-in emoji parser. When enabled, default shortcode categories render as descriptive Unicode changelog headings (for example,🐛 Bug Fixes) and the classified leading tag is removed from the commit summary.The default behavior remains unchanged, and custom tags that do not have a built-in display label continue to use their configured value.
Rationale
The changelog already groups entries using
ParsedMessageResult.categoryand renders the first description as the bullet text. Keeping the change in the emoji parser avoids a second template tree and avoids a runtime dependency: the parser can opt in to a static mapping for the tags it already supports, while preserving backward compatibility.How did you test?
1055 passed.4266 passed, 15 skipped.mypy .reaches four existingimportlib.resources/importlib_resourcesno-redeferrors in untouched files under Python 3.13.git diff --checkpassed.How to Verify
commit_parser = "emoji".commit_parser_options.render_emoji = true.:bug: correct some textand generate a changelog.🐛 Bug Fixesand the bullet begins withCorrect some text, without the:bug:prefix.AI disclosure
I used OpenAI Codex to help investigate the issue, implement the change, and run validation. I reviewed the final diff, test results, and PR description before submission.
PR Completion Checklist