Reformat the git-cliff release notes

[joshka]

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

• fea(layout): Mark various functions as const #951
• ...

Pinging @orhun for additonal thoughts

[orhun]

It looks like we also get double headers for some reason. (v0.26.2 and then v0.26.2 2024-04-15)

I'm unable to reproduce this, can you show me an example?

A top section that just directly lists the commit message titles e.g.:

Yeah, it should be fairly simple to do that. Looks similar to the github template example.

A couple of questions:

• Are you proposing the revamp the entire changelog format or just adding a summary?
• What's wrong with the current format? Yeah it's long but everything is there. I especially like the fact that we include the commit body. Maybe we can make it a collapsible content though, not sure.

[joshka]

I'm unable to reproduce this, can you show me an example?

Details

https://github.com/ratatui-org/ratatui/releases/tag/v0.26.2

joshka/tui-scrollview#28

Compare: joshka/tui-scrollview#14

Are you proposing the revamp the entire changelog format or just adding a summary?

Change the format so that the important information is up top in the zone that doesn't get truncated by the tooling around releases.

What's wrong with the current format? Yeah it's long but everything is there. I especially like the fact that we include the commit body. Maybe we can make it a collapsible content though, not sure.

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:

and joshka/tui-scrollview#28

[orhun]

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 v, using ## instead of # or even including the link. I'm not sure how to fix that, but we can try to keep it simple by just including the version (similar to mio) next time and hope that it doesn't duplicate it. It's lowkey brute forcing, but I really don't want to dig into some Ruby code to find it out. But I digged in anyways: https://github.com/dependabot/dependabot-core/blob/7b25e935cd0a1f9a89abf6ce865cea69090c298d/common/lib/dependabot/metadata_finders/base/changelog_finder.rb#L57

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):

## Summary
* docs(github): update code owners about past maintainers
* fix(examples): changed user_input example to work with multi-byte unicode chars by @OkieOth in [#1069](https://github.com/ratatui-org/ratatui/pull/1069)
* fix(examples): fix key handling in constraints by @psobolik in [#1066](https://github.com/ratatui-org/ratatui/pull/1066)
* docs(github): update code owners by @orhun in [#1067](https://github.com/ratatui-org/ratatui/pull/1067)

But then we will be duplicating the entries in the changelog, hmm..

[joshka]

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.

[orhun]

What do you think of doing something like the following for less verbosity?

97ee102 (buffer) Track_caller for index_of by @EdJoPaTo in #1046

The caller put in the wrong x/y -> the caller is the cause.

[orhun]

sorry for the false ping, I just wanted to share an example :D

[joshka]

What do you think of doing something like the following for less verbosity?

I don't think there's a way to make the summary interpret markdown on the first line