Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Release Notes linting improvements #3767

Open
npolshakova opened this issue Sep 18, 2024 · 0 comments
Open

Release Notes linting improvements #3767

npolshakova opened this issue Sep 18, 2024 · 0 comments
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject kind/feature Categorizes issue or PR as related to a new feature. needs-priority sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@npolshakova
Copy link
Contributor

What would you like to be added:

Add tooling to check release notes maps before they are merged into sig-release to prevent invalid yaml and catch common errors.

Why is this needed:

The release notes team's handbook has a number of listed TODOs. Adding a workflow to check invalid yaml, spelling, grammar and punctuation checks would help automate the review process

Also see: kubernetes/sig-release#2498
@npolshakova npolshakova added kind/feature Categorizes issue or PR as related to a new feature. sig/release Categorizes an issue or PR as relevant to SIG Release. area/release-eng Issues or PRs related to the Release Engineering subproject labels Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject kind/feature Categorizes issue or PR as related to a new feature. needs-priority sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@npolshakova @k8s-ci-robot