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
Reformat the git-cliff release notes #1060
Comments
I'm unable to reproduce this, can you show me an example?
Yeah, it should be fairly simple to do that. Looks similar to the A couple of questions:
|
Details
https://github.com/ratatui-org/ratatui/releases/tag/v0.26.2 Compare: joshka/tui-scrollview#14
Change the format so that the important information is up top in the zone that doesn't get truncated by the tooling around releases.
I'd like to see this in a format that works well with the ecosystem of tools that are in use. That includes dependabot, github releases, and the github home feed. Long is fine, but for the most part, tools truncate things the changelog / release notes, so it's important to include the right information up front: |
Okay I see what you mean. Regarding Dependabot duplicating the header, it might be happening due to multiple things. Maybe it's because we're missing Do you think adding a summary section to the top of the changelog only from the "feature" commits is a good idea? For example (assume they are all feature commits):
But then we will be duplicating the entries in the changelog, hmm.. |
I'm not too sure. Btw, this is very much one of those places which is about gold plating, but I've called it out as you own git cliff and gold plating here might help the wider git cliff perspective. |
sorry for the false ping, I just wanted to share an example :D |
I don't think there's a way to make the summary interpret markdown on the first line |
Problem
I'd like to see a much more compact summary of changes in each release that works well with dependabot and other tooling.
E.g. joshka/ratatui-widgets#22 truncates the changelog
It looks like we also get double headers for some reason. (v0.26.2 and then v0.26.2 2024-04-15)
Solution
A top section that just directly lists the commit message titles e.g.:
Summary
Pinging @orhun for additonal thoughts
The text was updated successfully, but these errors were encountered: