Document Deprecation Requirements for CLI #744
Labels
kind/documentation
Categorizes issue or PR as related to documentation.
lifecycle/rotten
Denotes an issue or PR that has aged beyond stale and will be auto-closed.
There is no documentation currently on the approach that should be used to deprecate or change features of the CLI that will break backwards compatibility. At the moment, there is an informal approach used, which is to give a full release to warn about a breaking change, log a message from the CLI when applicable to give users a more direct warning about the change, and document that deprecation notice or behavior change in release notes for the version before when the change will take place.
Pipeline has a policy for API changes that we can use as a reference. This issue can serve as a place of discussion for if there are CLI-specific issues that should be considered for this, and this approach can be introduced at any time once there is an agreement in place. At the very least, the approach should be presented and agreed upon in a CLI working group.
The text was updated successfully, but these errors were encountered: