cluster-api: Release note tool should not ignore squashed PRs
The release note tool has the limitation that it ignores squashed PRs, which is why we always have to ask contributors to squash their commits before we can merge.
It would be nice to take a closer look if there is a way to get rid of this limitation.
I would avoid a lot of toil that we have when we have to ask for squashes.
To be clear, we could then use the tide/merge-method-squash label and tide would squash for us. Today this is not really possible as the PR then would not show up in the release notes.
About this issue
- Original URL
- State: open
- Created 10 months ago
- Comments: 26 (26 by maintainers)
Hi @furkatgofurov7 - unfortunately no real updates to share. I am working on adding the fix to our tool though and just have been delayed due to time constraints and have been putting this off… I will commit to having a PR to share by next Wednesday
I would definitely appreciate the improvement. While core CAPI might move to the upstream tool, I don’t know what other providers will do. In CAPV I would in any case like to continue to use this tool (didn’t discuss it with the CAPV community yet though) and this might apply to a lot of other providers as well.
This tool is currently used by core CAPI and 5 other providers (https://cs.k8s.io/?q=sigs.k8s.io%2Fcluster-api%2Fhack%2Ftools%2Frelease&i=nope&files=&excludeFiles=&repos=).
So I can imagine that even if the release team doesn’t want to invest in this tool anymore we might still keep it in core CAPI for usage by providers (the only alternative would be to fork it into each provider, which doesn’t seem like a great option, or everyone has to move to the upstream tool or something in between)
Note: the PR https://github.com/kubernetes-sigs/cluster-api/pull/9263 should be usable for testing this in CAPI once it’s merged. I’ve added two commits and the label for tide to squash it.
Just remembered. We had a few squashed PRs in controller-runtime. If you run the release note tool on main with previous tag v0.15 there should be a few.
https://github.com/kubernetes-sigs/controller-runtime/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aclosed+label%3Atide%2Fmerge-method-squash
e.g.: https://github.com/kubernetes-sigs/controller-runtime/pull/2406
Workflow:
I’m not sure if that CAPV PR is a good example. According to GitHub the squash label was never applied.
I would suggest to just merge a not-super-important-for-release-notes PR in core CAPI with the squash method and then check if it shows up in the generated release notes (I’m pretty sure it won’t)
/triage accepted
Thanks, this is a great improvement, I personally was not aware of this limitation. Adding it to 1.6 improvements tasks