Changelog could be more "readable"

famod commented 4 years ago

Description First off: thanks a lot for the frequent releases and that you publish detailed changelogs (some projects don't to that at all).

I find the current changelogs (under https://github.com/quarkusio/quarkus/releases) a bit hard to read:

often both the issue ticket and the respective PR(s) are listed which leads to duplicates or in case the PR is worded differently one is under the impression that two different things were fixed/changed
it is not clearly visible whether an issue/PR is fixing/changing only internal stuff like infra, internal tests etc.
it is not clearly visible that a .0.Final does not list all changes since the last regular release (you have to look for the CRx releases as well)
it would be helpful to add a link to the respective migration wiki article

Implementation ideas For the internal/external aspect: Many projects in the Jenkins universe use this: https://github.com/release-drafter/release-drafter#categorize-pull-requests With this release drafter you can (apparently) create nicely categorized changelogs. Example: https://github.com/jenkinsci/jenkins/releases grafik

famod commented 4 years ago

@gsmet WDYT?

famod commented 4 years ago

Btw, the icing on the cake would be to group issues/PRs per extension or area.

quarkusio / quarkus