🐛 Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE #10435

chandankumar4 · 2024-04-14T05:26:30Z

What this PR does / why we need it:

Add Previous release tag version for RELEASE CANDIDATE/BETA RELEASE

For RELEASE CANDIDATE/BETA RELEASE

$ RELEASE_TAG=v1.7.0-rc.1 PREVIOUS_VERSION_TAG=tags/v1.7.0-rc.0 make release-notes

go build -C hack/tools -o /Users/ckumar14/go/src/github.com/sigs.k8s.io/cluster-api/bin/notes -tags tools sigs.k8s.io/cluster-api/hack/tools/release/notes
./bin/notes --release v1.7.0-rc.1 --previous-release-version tags/v1.7.0-rc.0 > CHANGELOG/v1.7.0-rc.1.md
2024/04/14 10:46:08 Computing diff between v1.7.0-rc.0 and heads/release-1.7
2024/04/14 10:46:08 Calling endpoint repos/kubernetes-sigs/cluster-api/compare/v1.7.0-rc.0...release-1.7?per_page=250&page=1&
2024/04/14 10:46:09 Total of 1 pages and 31 elements read
2024/04/14 10:46:09 Reading ref heads/release-1.7 for upper limit
.....

For Release TAG

$ RELEASE_TAG=v1.7.0 make release-notes

go build -C hack/tools -o /Users/ckumar14/go/src/github.com/sigs.k8s.io/cluster-api/bin/notes -tags tools sigs.k8s.io/cluster-api/hack/tools/release/notes
./bin/notes --release v1.7.0 --previous-release-version "" > CHANGELOG/v1.7.0.md
2024/04/14 10:56:07 Computing diff between tags/v1.6.0 and heads/release-1.7
2024/04/14 10:56:07 Calling endpoint repos/kubernetes-sigs/cluster-api/compare/v1.6.0...release-1.7?per_page=250&page=1&
2024/04/14 10:56:09 Calling endpoint repos/kubernetes-sigs/cluster-api/compare/v1.6.0...release-1.7?per_page=250&page=2&
.....

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #10396

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

k8s-ci-robot · 2024-04-14T05:26:38Z

This PR is currently missing an area label, which is used to identify the modified component when generating release notes.

Area labels can be added by org members by writing /area ${COMPONENT} in a comment

Please see the labels list for possible areas.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot · 2024-04-14T05:26:39Z

Hi @chandankumar4. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot · 2024-04-14T05:26:40Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign justinsb for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Makefile

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

Makefile

sbueringer · 2024-04-17T13:19:39Z

Makefile

@@ -1166,7 +1164,7 @@ release-notes-tool:

 .PHONY: release-notes
 release-notes: release-notes-tool
-	./bin/notes --release $(RELEASE_TAG) > CHANGELOG/$(RELEASE_TAG).md
+	./bin/notes --release $(RELEASE_TAG) --previous-release-version "$(PREVIOUS_VERSION_TAG)" > CHANGELOG/$(RELEASE_TAG).md



Related: is it documented anywhere that PREVIOUS_VERSION_TAG has to be set?

No it's not documented anywhere yet, is there any place where I can document it?

@cahillsf I assume you have an idea :)

cluster-api/docs/release/release-tasks.md

Line 361 in a52ab37

#### Create PR for release notes

would be a good place.

Ideally we properly document it with an example for a rc and a stable version.

Yep looks like the right place to me too

Updated the release docs

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

docs/release/release-tasks.md

typeid · 2024-04-19T12:52:27Z

docs/release/release-tasks.md

   ```bash
   # RELEASE_TAG should be the new desired tag (note: at this point the tag does not yet exist).
+   # PREVIOUS_VERSION_TAG is the previous released tag for determining the changes.


How would this work for the first pre-release version without a pre-release precedent? Is that worth documenting as well?

Updated the docs for the same, a minor code change was also required for it.

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

enxebre · 2024-05-31T14:09:44Z

hack/tools/release/notes/main.go

@@ -187,12 +187,6 @@ func validateConfig(config *notesCmdConfig, releaseType string) error {
 		}
 	}

-	if releaseType != "" {


why is this going away?

enxebre · 2024-05-31T14:12:44Z

Makefile

-    PRE_RELEASE=true
-endif
-# the previous release tag, e.g., v0.3.9, excluding pre-release tags
-PREVIOUS_TAG ?= $(shell git tag -l | grep -E "^v[0-9]+\.[0-9]+\.[0-9]+$$" | sort -V | grep -B1 $(RELEASE_TAG) | head -n 1 2>/dev/null)


where was this used? I can't find any ref

Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE

609d4c8

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label labels Apr 14, 2024

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 14, 2024

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 14, 2024

k8s-ci-robot requested review from fabriziopandini and richardcase April 14, 2024 05:26

chandankumar4 changed the title ~~Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE~~ 🐛 Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE Apr 14, 2024

sbueringer reviewed Apr 15, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

sbueringer reviewed Apr 15, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

Remove unused variable and update release-notes cmd

a1945a6

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

chandankumar4 requested a review from sbueringer April 16, 2024 17:16

sbueringer reviewed Apr 17, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

sbueringer reviewed Apr 17, 2024

View reviewed changes

Makefile Show resolved Hide resolved

sbueringer reviewed Apr 17, 2024

View reviewed changes

Update release process document

e213050

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 19, 2024

chandankumar4 requested a review from sbueringer April 19, 2024 12:19

typeid reviewed Apr 19, 2024

View reviewed changes

Add notes for first pre-release version

a2f5956

Signed-off-by: chandankumar4 <chandan.kr404@gmail.com>

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 5, 2024

chandankumar4 requested a review from typeid May 5, 2024 06:39

chandankumar4 requested a review from cahillsf May 13, 2024 14:49

enxebre reviewed May 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE #10435

🐛 Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE #10435

chandankumar4 commented Apr 14, 2024

k8s-ci-robot commented Apr 14, 2024

k8s-ci-robot commented Apr 14, 2024

k8s-ci-robot commented Apr 14, 2024

sbueringer Apr 17, 2024

chandankumar4 Apr 17, 2024

sbueringer Apr 17, 2024 •

edited

typeid Apr 18, 2024 •

edited

cahillsf Apr 19, 2024

chandankumar4 Apr 19, 2024

typeid Apr 19, 2024

chandankumar4 May 5, 2024

enxebre May 31, 2024

enxebre May 31, 2024

🐛 Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE #10435

Are you sure you want to change the base?

🐛 Set previous release tag version for RELEASE CANDIDATE/BETA RELEASE #10435

Conversation

chandankumar4 commented Apr 14, 2024

k8s-ci-robot commented Apr 14, 2024

k8s-ci-robot commented Apr 14, 2024

k8s-ci-robot commented Apr 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbueringer Apr 17, 2024 • edited

Choose a reason for hiding this comment

typeid Apr 18, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbueringer Apr 17, 2024 •

edited

typeid Apr 18, 2024 •

edited