Adding deprecation messages
We store a list of deprecations associated with it in the
list method of
If a configuration has to be deprecated, it has to be added to that list with
Note: The process described below will become obsolete soon, with our new deprecation management logic.
As part of our deprecation policy we may need to add
gitlab-ctl reconfigure that advise the user of any deprecated
settings they are using.
To do this we should add code that detects the use of the old setting,
handles the value (for instance remapping it to a new setting), and notify the
user that they have something to do with
Here’s an example from the
def parse_nginx_listen_address return unless Gitlab['nginx']['listen_address'] # The user specified a custom NGINX listen address with the legacy # listen_address option. We have to convert it to the new # listen_addresses setting. LoggingHelper.deprecation "nginx['listen_address'] is deprecated. Please use nginx['listen_addresses']" Gitlab['nginx']['listen_addresses'] = [Gitlab['nginx']['listen_address']] end
If we need to print Ruby objects, we can make use of the
print_ruby_object helper method. This needs
OutputHelper class to be
included in your code. Take a look at Gitaly library
for an example.