This repository was archived by the owner on Aug 23, 2023. It is now read-only.
This repository was archived by the owner on Aug 23, 2023. It is now read-only.
Versioning #1838
Description
We have been having discussions recently about introducing versioning to either the public or internal APIs, or both. Let's continue that discussion here and see where it goes.
One of the more profound benefits is related to documentation. Once versioning is used it would be a lot easier to deprecate older documentation. Currently, whenever we introduce a breaking change, that change appears in the CHANGELOG, but that's about it. This could be slightly easier with versioning. An operator / user could simply look up what version they are using and get the correct documentation instead of trying to look at commit hashes or pull requests.
Some things it may not solve:
- The requirement to perform colored rollouts after a breaking change