-
-
Notifications
You must be signed in to change notification settings - Fork 377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(changelog): show full commit message #423
Conversation
Codecov Report
@@ Coverage Diff @@
## main #423 +/- ##
=======================================
Coverage 86.41% 86.41%
=======================================
Files 40 40
Lines 9432 9432
=======================================
Hits 8151 8151
Misses 1281 1281 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is in addition to sometime making a BREAKING_CHANGES.md, not a replacement for that idea.
This allows someone reading the changelog to search for information about breaking changes or implementation of new functionality. - refactored the commit template part to a macro instead of repeating it - added a link to the commit and to the release - updated the current changelog for the alpha and unreleased changes - Automatically changed the existing * lists to - lists
a203358
to
3e752c4
Compare
I personally like this change, but I'm also curious if others have opinions on whether it is too verbose or not for a changelog. |
I gave that a bit of consideration.
I think the tradeoff is reasonable, but there's also a third approach we could have that moves the details to another section under the list of changes. It's a bit more work though. |
P.s. Don't merge this just yet - letting @orhun take some time to look at some git cliff stuff before we do that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just tested this and liked the changelog output. I agree with @joshka's comments about tradeoff.
Also, using a macro is a nice refactor 💯 Applied it in git-cliff's changelog.
This allows someone reading the changelog to search for information
about breaking changes or implementation of new functionality.