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

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

Open
caarmen opened this issue Sep 25, 2024 · 3 comments
Open

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

caarmen opened this issue Sep 25, 2024 · 3 comments

Comments

@caarmen
Copy link

caarmen commented Sep 25, 2024

Regarding the release notes:

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

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!

@dpopp07
Copy link

dpopp07 commented Dec 20, 2024

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?

@caarmen
Copy link
Author

caarmen commented Dec 20, 2024

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 👍

@UlisesGascon UlisesGascon transferred this issue from expressjs/express Dec 20, 2024
@wesleytodd
Copy link
Member

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.

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

No branches or pull requests

3 participants