Skip to content

Version KEP template and check for latest version in PR jobsΒ #3851

Open
@marosset

Description

What would you like to be added:

We should version the README.md KEP template file and ensure that PRs that update the README files under https://github.com/kubernetes/enhancements/tree/master/keps have been updated to use the latest template.

Why is this needed:

Occasionally there are updates to the KEP templates in between releases and when the templates change between enhancement stages it:

  • Extra work on the enhancements team as they need to ensure that each enhancement opted into a release is using the latest template (which today is a manual process)
  • Confusion and risk for enhancement authors who may not have been aware that the templates changed, and updates are required when updating the KEPs to be included in a release.

https://kubernetes.slack.com/archives/CPNHUMN74/p1675716127904979
This also happened between v1.24 and v1.25 when the Test Plan section of the KEP template was updated.

Proposal

We could also consider adding logic to the PR job to ensure the ToC / basic structure of the README.md files containers required sections.

Metadata

Labels

area/enhancementsIssues or PRs related to the Enhancements subprojectkind/featureCategorizes issue or PR as related to a new feature.sig/architectureCategorizes an issue or PR as relevant to SIG Architecture.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions