[CI] Improve git cliff config #3611
Merged
Conversation
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
TomerShor
approved these changes
Apr 23, 2025
Comment on lines
+81
to
+83
| { body = ".*security", group = "<!-- 9 -->🛡️ Security" }, | ||
| { message = "(?i)^\\[.*\\].*refactor", group = "<!-- 2 -->🚜 Refactor" }, | ||
| { message = "(?i)^\\[.*\\].*fix", group = "<!-- 1 -->🐛 Bug Fixes" }, |
There was a problem hiding this comment.
@TomerShor for groupping yes, the first match is put into group, other won't be considered.
Comment on lines
+35
to
+37
| {% set first_line = commit.message | split(pat="\n") | first %} | ||
| {{ first_line }}{% if commit.github.username %} by @{{ commit.github.username }}{% endif %} | ||
| {% if commit.github.pr_number and ('#' ~ commit.github.pr_number) not in first_line %} in #{{ commit.github.pr_number }}{% endif %} |
There was a problem hiding this comment.
How are you testing the jinja code locally?
There was a problem hiding this comment.
@TomerShor I use gitcliff CLI
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.
This PR updates the Jinja2 changelog template to prevent duplicate PR references in the rendered output.
Previously, if a commit message already included a PR reference (e.g. (#1234)), the template would append another in #1234, resulting in duplicated links.
The grouping logic has also been updated. If the group is [CI] or [Test] and the commit message starts with a fix prefix, it will no longer be categorized under Bug Fixes. This helps ensure commits are grouped more accurately by their context rather than just their prefix.