From 8279c822edfedf56d0dd49c7c1f5008a5a11e4bb Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Tue, 29 Nov 2022 16:09:55 +0100 Subject: [PATCH] incorporate requested changes Signed-off-by: Christian Richter --- docs/ocis/development/deprecating-variables.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/ocis/development/deprecating-variables.md b/docs/ocis/development/deprecating-variables.md index be7fd2f081..e61549b5b8 100644 --- a/docs/ocis/development/deprecating-variables.md +++ b/docs/ocis/development/deprecating-variables.md @@ -20,7 +20,7 @@ when it is going to be removed and why. ```golang // Nats is the nats config type Nats struct { -Host string `yaml:"host" env:"NATS_HOST_ADDRESS,NATS_NATS_HOST" desc:"Bind address." deprecationVersion:"1.6.2" removalVersion:"1.7.5" deprecationInfo:"NATS_NATS_HOST is confusing" deprecationReplacement:"NATS_HOST_ADDRESS"` +Host string `yaml:"host" env:"NATS_HOST_ADDRESS;NATS_NATS_HOST" desc:"Bind address." deprecationVersion:"1.6.2" removalVersion:"1.7.5" deprecationInfo:"NATS_NATS_HOST is confusing" deprecationReplacement:"NATS_HOST_ADDRESS"` ... } ``` @@ -33,3 +33,7 @@ There are four different annotation variables that need to be filled: | removalVersion| The version the variable will be removed from the codebase| semver (e.g. 1.7.3)| | 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) | | depreactionReplacement | The name of the variable that is going to replace the deprecated on.| string (e.g. NATS_HOST_ADDRESS)| + +### What happens next? + +Once a variable has been finally removed, the annotations must be removed again from the code, since they do not serve any purpose from this point. \ No newline at end of file