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.

Sign up for GitHub

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

Jump to bottom

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

Open
typeid opened this issue Apr 8, 2024 · 5 comments · May be fixed by #10435
Open

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

typeid opened this issue Apr 8, 2024 · 5 comments · May be fixed by #10435
Assignees
@chandankumar4
Labels
area/release Issues or PRs related to releasing kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@typeid
Copy link
Contributor

typeid commented Apr 8, 2024

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
Copy link
Contributor Author

typeid commented Apr 8, 2024

/area release

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. area/release Issues or PRs related to releasing labels Apr 8, 2024
@chandankumar4
Copy link
Contributor

I'll work on this issue, as it looks to be happening after my previous PR #10091
/assign

@chrischdi
Copy link
Member

/kind bug

@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Apr 10, 2024
@fabriziopandini
Copy link
Member

/priority important-soon

@k8s-ci-robot k8s-ci-robot added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Apr 11, 2024
@chandankumar4 chandankumar4 linked a pull request Apr 14, 2024 that will close this issue
Open
@fabriziopandini
Copy link
Member

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chandankumar4 chandankumar4

Labels
area/release Issues or PRs related to releasing kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

🐛 Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE chandankumar4/cluster-api
5 participants
@chrischdi @fabriziopandini @k8s-ci-robot @chandankumar4 @typeid