mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-05-06 07:03:11 -04:00
Code Issues Packages Projects Releases Wiki Activity

[docs-only] update the deprecation description (removal version rule)

Browse Source 
The removal version can only be, according to semver, a major version.
This commit is contained in:
Martin
2023-04-19 08:49:49 +02:00
committed by GitHub
parent b9dc2baaed
commit 44cf255813
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ocis/development/deprecating-variables.md
View File

@@ -30,7 +30,7 @@ There are four different annotation variables that need to be filled:
| Annotation |Description| Format|
|---|---|---|
| deprecationVersion| The version the variable will be deprecated| semver (e.g. 1.6.2)|
| removalVersion| The version the variable will be removed from the codebase| semver (e.g. 1.7.3)|
| removalVersion| The version the variable will be removed from the codebase. Note that according to semver, a removal can only be made in a major version change| semver (e.g. 4.0.0)|
| deprecationInfo| Information why the variable is deprecated, must start with the name of the variable in order to avoid confusion, when there are multiple options in the `env:`-field | string (e.g. NATS_NATS_HOST is confusing) |
| deprecationReplacement | The name of the variable that is going to replace the deprecated one.| string (e.g. NATS_HOST_ADDRESS)|