Backport changelog improvements #36346
Conversation
There was a problem hiding this comment.
LGTM but let's not merge this until the 1.11.0-beta1 release is completely finished. cc @SarahFrench
By changing the folder changie uses for the changelog we can make sure that users can put the changelog entries into a specific folder based on if the change will be backported. This way it will only appear in the patch release of the maintenance branch and not in the changelog of the current development branch.
DanielMSchmidt
force-pushed
the
backport-changelog-improvements
branch
from
009b7bb to
7f9c178
Compare
| 1.11.0-beta1 | ||
| 1.11.0-dev |
There was a problem hiding this comment.
What should this value be when doing post-release cleanup after 1.11.0-beta1? Should it be reverting this way? (Genuine question, not saying it's necessarily incorrect)
There was a problem hiding this comment.
I think we don't care about the value besides from the point when we do the release.
There was a problem hiding this comment.
Historically it has been set to the next release to be done, but I don't think it matters, right @radeksimko / @liamcervante ?
There was a problem hiding this comment.
It looks like in the past it updated it to the next version:
There was a problem hiding this comment.
...however, that probably doesn't matter as preparing the release branch for subsequent releases will update the VERSION value to the correct one: https://github.com/hashicorp/terraform-releases?tab=readme-ov-file#prepare-the-release-branch
There was a problem hiding this comment.
It would be great to keep some way of telling two binaries apart even when they're built outside of the usual release process, so technically dev suffix makes that harder because it merges all patch releases into one - i.e. anything custom built between 1.11.0-alpha and 1.11.0 (final) will become indistinguishable.
All that said it's not a great way of solving that problem anyway and I would much rather see us solving it e.g. by encoding revisions into the binary alongside the semver, like Vault, Boundary or Nomad do.
|
I confirmed with Radek that it's ok to merge this as post-release clean up. I just want to confirm that the cleanup done here is as expected and then I'm happy to merge |
There was a problem hiding this comment.
Approving as it looks like any difference in post-release cleanup in this PR will be caught by other steps in the process (see: #36346 (comment))
By merging this I'm backporting the changelog generation changes but also effectively doing the post-release cleanup after releasing 1.11.0-beta earlier today
Fixes #
Target Release
1.11.x
CHANGELOG entry