discussions icon indicating copy to clipboard operation
discussions copied to clipboard

Group release notes items by category (features, fixes, etc).

Open caarmen opened this issue 1 year ago • 3 comments

Regarding the release notes:

Thank you for highlighting the important changes in release notes in an "important" section :pray:

Would it be possible to organize the other changes, to make it easier to browse the changes?

Like: group the bug fixes together, new features together, doc changes together, lib updates together.

It would be really helpful to have an idea of the impact of upgrading to a new release.

Thanks a lot!

caarmen avatar Sep 25 '24 09:09 caarmen

I like this idea. To clarify, are you talking about the History.md notes or the release notes on the website (or both)? Some of the v5.x entries in the History.md file are grouped with more specificity (e.g. "remove", "change", "add") - do you find that style of grouping helpful?

dpopp07 avatar Dec 20 '24 15:12 dpopp07

Actually I didn't even see those two sources before 😅 I was looking at the release section of the GitHub project.

For example, the release notes for 4.20.0: https://github.com/expressjs/express/releases/tag/4.20.0

Indeed the grouping in the history.md file for the 5.x releases is an improvement 👍

caarmen avatar Dec 20 '24 16:12 caarmen

I agree the current setup is not great. I think we have agreed we will be automating all of this with some tooling as part of the release process. I will leave this open so we can find it, but I dont think we will address this without said automation.

wesleytodd avatar Jan 10 '25 18:01 wesleytodd