-
Notifications
You must be signed in to change notification settings - Fork 397
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 release notes validation workflow #2698
base: master
Are you sure you want to change the base?
Add krel release notes validation workflow #2698
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: npolshakova 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 |
/assign |
What type of PR is this:
/kind feature
What this PR does / why we need it:
Adds a GitHub Action to setup krel.
This is required to setup a presubmit job for PRs like: #2659. The current requirement is to add validation using:
$ krel release-notes validate --help
krel release-notes validate
The 'validate' subcommand of krel has been developed to:
Check release notes maps for valid yaml.
Check release notes maps for valid punctuation.
The release notes team is blocked whenever invalid yaml is merged into sig-release:
#2589
#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). This workflow automates preventing invalid yaml from merging into sig-release.
Which issue(s) this PR fixes:
Fixes kubernetes/release#2753
Special notes for your reviewer:
Based on @Vyom-Yadav's GitHub workflow: kubernetes-sigs/release-actions#101