Skip to content
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

Merged
merged 1 commit into from
Aug 24, 2023

Conversation

joshka
Copy link
Member

@joshka joshka commented Aug 21, 2023

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

image

@codecov
Copy link

codecov bot commented Aug 21, 2023

Codecov Report

Merging #423 (3e752c4) into main (6153371) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #423   +/-   ##
=======================================
  Coverage   86.41%   86.41%           
=======================================
  Files          40       40           
  Lines        9432     9432           
=======================================
  Hits         8151     8151           
  Misses       1281     1281           

Copy link
Member Author

@joshka joshka left a 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.

CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@joshka joshka added this to the v0.23.0 milestone Aug 21, 2023
CHANGELOG.md Show resolved Hide resolved
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
@kdheepak
Copy link
Collaborator

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.

@joshka
Copy link
Member Author

joshka commented Aug 23, 2023

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.

  • The pro side is that more details = easier to search for information using Ctrl/Cmd+F. Finding what changed in a git commit history is often more difficult compared to searching a single file like this.
  • The cons are that having too many details can get in the way of seeing the high level view of things overview.

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.

@joshka
Copy link
Member Author

joshka commented Aug 23, 2023

P.s. Don't merge this just yet - letting @orhun take some time to look at some git cliff stuff before we do that.

Copy link
Sponsor Member

@orhun orhun left a 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.

@orhun orhun added this pull request to the merge queue Aug 24, 2023
Merged via the queue into ratatui-org:main with commit a937500 Aug 24, 2023
30 checks passed
@joshka joshka deleted the chore-changelog-details branch August 24, 2023 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants