search

pypa / setuptools

Official project repository for the Setuptools build system
https://pypi.org/project/setuptools/
MIT License
2.34k stars 1.14k forks source link

NEWS: Put releases in numerical order #4304

Closed hugovk closed 1 month ago

hugovk commented 1 month ago

Summary of changes

I thought some releases were missing, but I guess they were added in chronological order rather than numerical.

Let's keep numerical, especially as no dates are shown.

Pull Request Checklist

[PR docs]: https://setuptools.pypa.io/en/latest/development/developer-guide.html#making-a-pull-request

abravalheri commented 1 month ago

Thank you very much

jaraco commented 3 weeks ago

I'm not sure putting the changes in numerical order is correct. Having them in temporal order provides better fidelity about what changes are included in a given release. In the current ordering, it looks like v69.5.1 includes no changes from v69.5.0, when in fact, 69.4.2 was released between 69.5.0 and 69.5.1, so the changelog now seemingly incorrectly signals that v69.5.0 includes v69.4.2 and that v69.5.1 had no significant changes. Same applies for v69.3.1 between v69.4.0 and v69.4.1.

Also, dates are shown in the rendered changelog.

I think we should revert this change, despite the confusion it might cause. If someone wants a changelog sorted by version number, they should re-render the changelog that way. You can mechanically convert from logic oldering to sorted versions, but not vice-versa (without additional information from the commit history).