Skip to content

Sync CHANGES file up to 4.6.0? Use as a mainstay? #2833

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

Closed
tony opened this issue Jul 5, 2023 · 4 comments
Closed

Sync CHANGES file up to 4.6.0? Use as a mainstay? #2833

tony opened this issue Jul 5, 2023 · 4 comments
Assignees
Labels
maintenance Maintenance (CI, Releases, etc)

Comments

@tony
Copy link
Contributor

tony commented Jul 5, 2023

Hi, thank you again for the project! I am re-kindling the request for more attention to be given to maintaining CHANGES. If curated, it can be very beneficial to users downstream.

Follow up to #1868 and #1915

Update to 4.6.0

Right now the CHANGES file is only as far as 4.0.0-beta2, as of #1915 (link)

Use CHANGES as main system?

Thoughts on sticking to CHANGES as a primary release note system?

It is very difficult to link other developers to changes across versions, e.g. 4.0.0 -> 4.6.0 requires (painstakingly) linking individually to 4.0.0, 4.0.1, 4.0.2, 4.1.0, 4.1.1, 4.2.0, 4.3.0, 4.4.0, 4.5.0, 4.6.0, etc.

For more context, #1868 and https://keepachangelog.com/en/1.1.0/

@chayim chayim added the maintenance Maintenance (CI, Releases, etc) label Jul 9, 2023
@chayim
Copy link
Contributor

chayim commented Jul 9, 2023

I'm supportive. Let's re-sync this back in the upcoming 5.x release (very close) if we can. If not, let's immediately do it in the release thereafter.

@akx
Copy link
Contributor

akx commented Sep 4, 2023

@chayim It's probably time to do this now :)

@petyaslavova
Copy link
Collaborator

The changes after version 4.0.0 are available in the repo's release notes, so there is no need to track them in CHANGES file.
The file will exist in the repository to keep the history for earlier versions.
The change is introduced with PR #3645

@tony
Copy link
Contributor Author

tony commented May 23, 2025

@petyaslavova This approach definitely makes life easier for maintainers, and less overhead is always a win!

However, from a downstream user's perspective, GitHub Releases can be quite cumbersome to work with. I detailed the specific pain points back in #1868 - and if long-term sustainability and accessibility of release notes are priorities for this project, those concerns remain relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance (CI, Releases, etc)
Projects
None yet
Development

No branches or pull requests

5 participants