🌱 Add validation for PREVIOUS_RELEASE_TAG in release-notes-tool #12380
+127
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
area/release
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/L
|
@chandankumar4 |
tsuzu
force-pushed
the
fix/12278-validate-previous-release-tag
branch
from
80ce3de to
a36f7cf
Compare
|
/retest |
sivchari
reviewed
Jun 20, 2025
hack/tools/release/notes/main.go
Outdated
| preReleaseRC = "rc" | ||
| preReleaseBeta = "beta" | ||
| preReleaseAlpha = "alpha" |
There was a problem hiding this comment.
Suggested change
| preReleaseRC = "rc" | |
| preReleaseBeta = "beta" | |
| preReleaseAlpha = "alpha" | |
| preReleaseAlpha = "alpha" | |
| preReleaseBeta = "beta" | |
| preReleaseRC = "rc" |
hack/tools/release/notes/main.go
Outdated
|
|
||
| versionStr := parts[1] | ||
|
|
||
| // Parse the version to check if it contains rc, beta, or alpha |
There was a problem hiding this comment.
Suggested change
| // Parse the version to check if it contains rc, beta, or alpha | |
| // Parse the version to check if it contains alpha, beta, or rc |
hack/tools/release/notes/main.go
Outdated
| func validatePreviousReleaseVersion(previousReleaseVersion string) error { | ||
| // Extract version string from ref format (e.g., "tags/v1.0.0-rc.1" -> "v1.0.0-rc.1") | ||
| if !strings.Contains(previousReleaseVersion, "/") { | ||
| return errors.New("--previous-release-version must be in ref format (e.g., tags/v1.0.0-rc.1)") |
There was a problem hiding this comment.
Suggested change
| return errors.New("--previous-release-version must be in ref format (e.g., tags/v1.0.0-rc.1)") | |
| return errors.New("--previous-release-version must be in ref format (e.g. tags/v1.0.0-rc.1)") |
Same with other error messages.
hack/tools/release/notes/main.go
Outdated
|
|
||
| // Check if the version has pre-release identifiers | ||
| if len(version.Pre) == 0 { | ||
| return errors.Errorf("--previous-release-version must contain '%s', '%s', or '%s' pre-release identifier", preReleaseRC, preReleaseBeta, preReleaseAlpha) |
There was a problem hiding this comment.
Suggested change
| return errors.Errorf("--previous-release-version must contain '%s', '%s', or '%s' pre-release identifier", preReleaseRC, preReleaseBeta, preReleaseAlpha) | |
| return errors.Errorf("--previous-release-version must contain '%s', '%s', or '%s' pre-release identifier", , preReleaseAlpha, preReleaseBeta, preReleaseRC) |
hack/tools/release/notes/main.go
Outdated
| // Check if the first pre-release identifier is 'rc', 'beta', or 'alpha' | ||
| preReleaseType := version.Pre[0].VersionStr | ||
| if preReleaseType != preReleaseRC && preReleaseType != preReleaseBeta && preReleaseType != preReleaseAlpha { | ||
| return errors.Errorf("--previous-release-version must contain '%s', '%s', or '%s' pre-release identifier", preReleaseRC, preReleaseBeta, preReleaseAlpha) |
There was a problem hiding this comment.
Suggested change
| return errors.Errorf("--previous-release-version must contain '%s', '%s', or '%s' pre-release identifier", preReleaseRC, preReleaseBeta, preReleaseAlpha) | |
| return errors.Errorf("--previous-release-version must contain '%s', '%s', or '%s' pre-release identifier", preReleaseAlpha, preReleaseBeta, preReleaseRC) |
hack/tools/release/notes/main.go
Outdated
| return errors.Errorf("--previous-release-version must contain '%s', '%s', or '%s' pre-release identifier", preReleaseRC, preReleaseBeta, preReleaseAlpha) | ||
| } | ||
|
|
||
| // Check if the first pre-release identifier is 'rc', 'beta', or 'alpha' |
There was a problem hiding this comment.
Suggested change
| // Check if the first pre-release identifier is 'rc', 'beta', or 'alpha' | |
| // Check if the first pre-release identifier is 'alpha', 'beta', or 'rc' |
Comment on lines
302
to
305
| if err == nil { | ||
| t.Errorf("expected error '%s', got no error", tt.errorMessage) | ||
| } else if !strings.Contains(err.Error(), tt.errorMessage) { | ||
| t.Errorf("expected error to contain '%s', got '%v'", tt.errorMessage, err) |
There was a problem hiding this comment.
Suggested change
| if err == nil { | |
| t.Errorf("expected error '%s', got no error", tt.errorMessage) | |
| } else if !strings.Contains(err.Error(), tt.errorMessage) { | |
| t.Errorf("expected error to contain '%s', got '%v'", tt.errorMessage, err) | |
| if err == nil || !strings.Contains(err.Error(), tt.errorMessage) { | |
| t.Errorf("expected error '%s', got %v", tt.errorMessage, err) | |
| } |
tsuzu
force-pushed
the
fix/12278-validate-previous-release-tag
branch
from
a36f7cf to
d74021f
Compare
k8s-ci-robot
added
the
do-not-merge/invalid-commit-message
Validate that PREVIOUS_RELEASE_TAG uses proper ref format and contains alpha, beta, or rc pre-release identifier. Co-authored-by: sivchari <[email protected]>
tsuzu
force-pushed
the
fix/12278-validate-previous-release-tag
branch
from
d74021f to
51a6c70
Compare
k8s-ci-robot
removed
the
do-not-merge/invalid-commit-message
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 73279cb64ee7f62263e788e108c8a03acd45214b
|
mboersma
approved these changes
Jun 23, 2025
| }, | ||
| wantErr: true, | ||
| errorMessage: "invalid --previous-release-version, is not a valid semver", | ||
| }, |
There was a problem hiding this comment.
It's good to add test case for beta version as well
k8s-ci-robot
removed
the
lgtm
|
New changes are detected. LGTM label has been removed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Add a validation logic for
make release-notes✅ Now Accepts:
❌ Now Rejects:
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 #12278
/area release