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.

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

Release Notes linting improvements #3767

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

Release Notes linting improvements #3767

npolshakova opened this issue Sep 18, 2024 · 3 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. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. 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
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 17, 2024
@xmudrii
Copy link
Member

xmudrii commented Dec 17, 2024

@npolshakova I remember some PRs about this topic, is this issue still relevant?

@puerco
Copy link
Member

puerco commented Dec 18, 2024

I think krel release-notes validate is the implementation and the new workflow should close this: kubernetes/sig-release#2698

(these supersede kubernetes-sigs/release-actions#101 )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-priority sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

No branches or pull requests

5 participants