-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Description
Summary
Following this PR, which lists the healthchecks added to the last releases, we can have a template file for the entire upgrade doc for each minor version.
Motivation
This way we will not forget to list the added healthchecks for the next release, and provide a structured approach to listing our significant dependency upgrades.
Proposal
We can add sections as Breaking Changes, Custom Healthchecks Added, Kustomize Upgraded, Helm Upgraded, or any other frequently used headers in our upgrade instructions.
We can potentially auto-create the next minor version empty upgrade guide with headlines from the template upon the release process of a first GA release of a new minor.
For example, when we create the release 3.3.0, we can add upgrading/3.3-3.4 file which will be based on the template and just have the headlines without the content. It will then be filled manually as 3.4 is being worked on.