As we move to introducing and deprecating features with the announcement of the DEPRECATIONS.md file in #3601, we should probably also dedicate space to where we may need to call out specific upgrade paths of Lagoon.
Example of where this would have been useful; When we released v2.10.0 we said that it paved the way for changes in v2.11.0. This basically meant people would have to upgrade to v2.10.0 before they could go to v2.11.0 or face potential issues. This was only made note of in the release notes.
It would be nice to keep track of these upgrade path requirements in a separate file, perhaps UPGRADES.md that can track significant upgrade paths. This can be linked to within release notes, or anywhere that people may ask if there is anything major that they need to be aware of when going from version X to version Y.
Some vendors have defined policies on upgrade paths
I'm not quite sure the best way to handle this for Lagoon. But IMO we don't release often enough to use a version skew policy effectively.
I'd propose instead a simple list that contains a target version, with a reference/note about the version you should be on before going to the target version.
As we move to introducing and deprecating features with the announcement of the
DEPRECATIONS.mdfile in #3601, we should probably also dedicate space to where we may need to call out specific upgrade paths of Lagoon.Example of where this would have been useful; When we released v2.10.0 we said that it paved the way for changes in v2.11.0. This basically meant people would have to upgrade to v2.10.0 before they could go to v2.11.0 or face potential issues. This was only made note of in the release notes.
It would be nice to keep track of these upgrade path requirements in a separate file, perhaps
UPGRADES.mdthat can track significant upgrade paths. This can be linked to within release notes, or anywhere that people may ask if there is anything major that they need to be aware of when going from version X to version Y.Some vendors have defined policies on upgrade paths
I'm not quite sure the best way to handle this for Lagoon. But IMO we don't release often enough to use a version skew policy effectively.
I'd propose instead a simple list that contains a target version, with a reference/note about the version you should be on before going to the target version.