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

Release notes should not include backports from previous versions #511

Open
jonkoops opened this issue Oct 8, 2024 · 2 comments
Open

Release notes should not include backports from previous versions #511

jonkoops opened this issue Oct 8, 2024 · 2 comments

Comments

@jonkoops
Copy link
Contributor

jonkoops commented Oct 8, 2024

When a release is done the changelog is created from the release labels attacked to the issues. However when an issue is backported to an older release the new release label is still attached. For example when an issue is fixed in main the release/26.1.0 is attached, however when this issue is backported it will also receive the release/26.0.1 lablel.

This means that when a release is done for release/26.0.1 the issue is added to the changelog for that release. Then when the 26.1.0 release is done it will include the same issue in the changelog again. This is counterintuitive and should not be happening.

@stianst
Copy link
Contributor

stianst commented Oct 10, 2024

I don't personally agree with this.

Release branches are forked from main, which results in them having a life on their own, and I'd say it's better to include everything that was added since the fork happened, then just what was added since the last patch release.

Now considering if we had some sort of LTS release, that could have a lifespan beyond the next major/minor release, which would just make it even more confusing what should or should not be included in the release notes.

@jonkoops
Copy link
Contributor Author

I think it's just very confusing to have:

26.0.1

  • Fixed issue X

26.1.0

  • Fixed issue X

This gives the impression that the issue wasn't fixed until 26.1.0 when I am reading the release notes This only makes sense if there are multiple supported releases at the same time receiving fixes in the form of backports.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants