kubernetes-sigs / cluster-api

Home for Cluster API, a subproject of sig-cluster-lifecycle
https://cluster-api.sigs.k8s.io
Apache License 2.0
3.48k stars 1.29k forks source link

Release notes generation documentation and `make` target don't work for release candidates #10396

Closed typeid closed 3 weeks ago

typeid commented 4 months ago

The release note generation documentation does not work for release candidates.

RELEASE_TAG=v1.7.0-rc.1 make release-notes 
go build -C hack/tools -o /home/kubernetes/cluster-api/bin/notes -tags tools sigs.k8s.io/cluster-api/hack/tools/release/notes
./bin/notes --release v1.7.0-rc.1 > CHANGELOG/v1.7.0-rc.1.md
2024/04/08 16:13:48 --previous-release-version need to be set with RELEASE CANDIDATE/BETA RELEASE tag
make: *** [Makefile:1169: release-notes] Error 1

The make target make release-notes does not allow providing this parameter:

.PHONY: release-notes
release-notes: release-notes-tool
    ./bin/notes --release $(RELEASE_TAG) --previous-release-version rc/v1.7.0-rc.0 > CHANGELOG/$(RELEASE_TAG).md

For rc/beta, we need to pass --previous-release-version to the the release notes generation tooling.

Correct call of the release note generation tooling for v1.7.0-rc.1:

./bin/notes --release v1.7.0-rc.1 --previous-release-version rc/v1.7.0-rc.0 > CHANGELOG/v1.7.0-rc.1.md

We should fix this issue and document the usage of make release-notes for release candidates.

typeid commented 4 months ago

/area release

chandankumar4 commented 4 months ago

I'll work on this issue, as it looks to be happening after my previous PR https://github.com/kubernetes-sigs/cluster-api/pull/10091 /assign

chrischdi commented 4 months ago

/kind bug

fabriziopandini commented 4 months ago

/priority important-soon

fabriziopandini commented 4 months ago

/triage accepted

k8s-triage-robot commented 1 month ago

This issue is labeled with priority/important-soon but has not been updated in over 90 days, and should be re-triaged. Important-soon issues must be staffed and worked on either currently, or very soon, ideally in time for the next release.

You can:

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted