-
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
/assign |
c469b5e
to
cc3bf07
Compare
KREL_VERSION=v0.17.12 |
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.
I've pinned this to v0.17.12
, if and when we do a new release of krel
, we'd need to update this. (I think there may be some automated job to do that, or we can add this to the handbook (for the lead to update it).
Alternatively, do we want to fetch the latest release?
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.
Hm, currently the handbook suggests the docs team uses the lastest krel, so maybe it's fine just fetching the latest release? https://github.com/kubernetes/sig-release/blob/ff03da9043cdd4cfd63f4c06c901909a744f2daa/release-team/role-handbooks/docs/README.md#tools
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.
Done, I changed to latest.
cc3bf07
to
b587da7
Compare
[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 |
Co-authored-by: npolshakova <[email protected]> Signed-off-by: Vyom-Yadav <[email protected]>
dea0462
to
83d5f96
Compare
/remove hold |
/assign @npolshakova |
Changes look good @Vyom-Yadav! Is there a way to make this workflow required when merging release notes changes in? @kubernetes/sig-release-leads It should only trigger on release notes changed conditions, but I think we might need admin permissions in GitHub to make it required? |
I think required workflows might not be supported anymore (for new workflows - https://docs.github.com/en/[email protected]/actions/sharing-automations/required-workflows), but a github admin can check that for us. Anyways, that can only be enabled after merging this action. |
/lgtm |
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