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

Full changelog for patch releases can be incorrect #961

Closed
triffer opened this issue Mar 22, 2024 · 0 comments
Closed

Full changelog for patch releases can be incorrect #961

triffer opened this issue Mar 22, 2024 · 0 comments
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@triffer
Copy link
Collaborator

triffer commented Mar 22, 2024

Description
When we create a release, we add a full changelog, which is a collection of changes since the last releases.
We always use the last release tag as a comparison when we create a changelog for a release, but there are scenarios where this is not correct if we want to create a patch for a release but there is already a release for a version with a higher major or minor version.

There is a branch release-2.2 with versions 2.2.0 and 2.2.1.
There is a branch release-2.3 with the versions 2.3.0.
If we now create a version 2.2.2, the full change log will use version 2.3.0 as the starting point instead of 2.2.1.

We can control the change log creation using the Changelog since field of the Create release action. We should update the release documentation to make it obvious that should be set for patch releases.

Expected result
The full changelog always uses the correct tag for a release.

Actual result
The full changelog always uses the latest release.

Steps to reproduce
See Description

Troubleshooting

@triffer triffer added the kind/bug Categorizes issue or PR as related to a bug. label Mar 22, 2024
@barchw barchw assigned barchw and unassigned barchw May 10, 2024
@triffer triffer assigned triffer and barchw and unassigned triffer May 13, 2024
@strekm strekm closed this as completed May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

No branches or pull requests

3 participants