-
Notifications
You must be signed in to change notification settings - Fork 502
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.
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
Add krel validate cmd #3765
Add krel validate cmd #3765
Conversation
@satyampsoni this can be used to validate the yamls instead of relying on the script. We can move this to a GitHub action once it goes in. |
9e25fc3
to
200851d
Compare
200851d
to
92cdea1
Compare
2f93528
to
21c7f05
Compare
4e62186
to
28b4db2
Compare
@kubernetes/sig-release-leads @xmudrii Can you give this another pass when you have a chance? Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few questions and nits, otherwise LGTM :)
Sorry for the delay!
28b4db2
to
0d66a2a
Compare
Thanks @xmudrii for the review! Here's the updated behavior with the cmd flag: If it's not provided:
If it's provided:
Then the top level krel help message:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cpanato, npolshakova, xmudrii The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
What type of PR is this?
/kind feature
What this PR does / why we need it:
Introduces new
krel validate <release-notes-maps>
command for release notes team to use when checking for invalid formatting.The release notes team is blocked whenever invalid yaml is merged into sig-release:
kubernetes/sig-release#2589
kubernetes/sig-release#2541
Invalid yaml can be introduced during the review process when people apply changes or manually edit the maps (not through krel, but in an editor).
Examples of runs:
Valid check:
Invalid yaml:
Which issue(s) this PR fixes:
Catches occurrences of #2753
Special notes for your reviewer:
Eventually, this command can be added to release-actions and run as a workflow similar to kubernetes/sig-release#2547.
Does this PR introduce a user-facing change?