Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-01-12 07:59:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note on how we handle deprecations (#2185)

Browse Source
This commit is contained in:
Otto Bittner 2023-08-21 16:48:10 +02:00 committed by GitHub
parent afa7fd0edb
commit b2fa9988b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
dev-docs/workflows/deprecations.md Normal file
View File

@ -0,0 +1,10 @@
# Deprecations
When removing a feature/flag/command we strive to mark said feature as deprecated one minor version before the removal happens.
I.e. to remove the CLI command `foo` in version v10.6, all invocations of `foo` in v10.5 should print a deprecation warning.
The deprecation should also be noted in the help text of the command to make it show up in the Constellation docs.
The changelog for v10.5 should contain a deprecation warning for `foo`.
The changelog for v10.6, should sort the removal of `foo` in the category `Breaking Changes`.
It may happen that the effort to implement a feature in this manner is deemed to high.