cluster-api icon indicating copy to clipboard operation
cluster-api copied to clipboard

Add check to validate the value of PREVIOUS_RELEASE_TAG in release-notes-tools

Open chandankumar4 opened this issue 5 months ago • 7 comments
trafficstars

What steps did you take and what happened?

Add check to validate PREVIOUS_RELEASE_TAG that it should contains rc or beta in the provided value.

For example

  1. Generating notes for rc tag RELEASE_TAG=v1.7.x-rc.1 PREVIOUS_RELEASE_TAG=tags/v1.7.x-rc.0 make release-notes
  2. Generating notes for beta tag RELEASE_TAG=v1.7.x-beta.1 PREVIOUS_RELEASE_TAG=tags/v1.7.x-beta.0 make release-notes

What did you expect to happen?

Validate should ensure that PREVIOUS_RELEASE_TAG is in correct format.

Cluster API version

v1.10

Kubernetes version

No response

Anything else you would like to add?

No response

Label(s) to be applied

/kind bug One or more /area label. See https://github.com/kubernetes-sigs/cluster-api/labels?q=area for the list of labels.

chandankumar4 avatar May 23 '25 10:05 chandankumar4

Why is only rc and beta supported?

sbueringer avatar May 23 '25 14:05 sbueringer

/help

chrischdi avatar May 28 '25 14:05 chrischdi

@chrischdi: This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to this:

/help

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-sigs/prow repository.

k8s-ci-robot avatar May 28 '25 14:05 k8s-ci-robot

/assign

tsuzu avatar May 28 '25 16:05 tsuzu

Thanks @tsuzu for taking up this issue. Feel free to ping me on slack, if you need any help!!

chandankumar4 avatar Jun 02 '25 17:06 chandankumar4

Listing patterns to use make release-notes (ref)

  • stable release (for new minor/patch releases): Running without PREVIOUS_RELEASE_TAG
    • RELEASE_TAG=v1.7.x make release-notes make release-notes
  • RC/beta/alpha releases
    • First pre-releases: Running without PREVIOUS_RELEASE_TAG
      • RELEASE_TAG=v1.7.x make release-notes make release-notes
    • Second or later pre-releases: Running with PREVIOUS_RELEASE_TAG
      • RELEASE_TAG=v1.7.x PREVIOUS_RELEASE_TAG=tags/v1.7.x-rc.0 make release-notes

Therefore, while PREVIOUS_RELEASE_TAG is specified, it's rc, beta, or alpha. so in this issue, we want to validate that rc, beta, or alpha is used unless empty.

@chandankumar4 Is my understanding correct?

tsuzu avatar Jun 10 '25 15:06 tsuzu

Why is only rc and beta supported?

I have to create a new issue to support alpha as well. Also we have different command for stable release RELEASE_TAG=v1.7.x make release-notes here

chandankumar4 avatar Jun 10 '25 15:06 chandankumar4