1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Enable deprecaded message for ignore_volatile_options (#3429)

* enable deprecate message for ignore_volatile_options

* fix E128

* add frament 3429

* remove default value and modify the resulting checks
spelling fixes
bump version for deprecated messge

* fix spelling and depricated version

Co-authored-by: Frank Dornheim <“dornheim@posteo.de@users.noreply.github.com”>
This commit is contained in:
Frank Dornheim 2021-09-28 07:07:55 +02:00 committed by GitHub
parent 1bb2ff5128
commit ef07f9b9ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 11 deletions

View file

@ -0,0 +1,2 @@
deprecated_features:
- "lxd_container - the current default value ``true`` of ``ignore_volatile_options`` is deprecated and will change to ``false`` in community.general 6.0.0 (https://github.com/ansible-collections/community.general/pull/3429)."

View file

@ -43,10 +43,9 @@ options:
- If set to C(true), options starting with C(volatile.) are ignored. As a result, - If set to C(true), options starting with C(volatile.) are ignored. As a result,
they are reapplied for each execution. they are reapplied for each execution.
- This default behavior can be changed by setting this option to C(false). - This default behavior can be changed by setting this option to C(false).
- The default value C(true) will be deprecated in community.general 4.0.0, - The current default value C(true) is deprecated since community.general 4.0.0,
and will change to C(false) in community.general 5.0.0. and will change to C(false) in community.general 6.0.0.
type: bool type: bool
default: true
required: false required: false
version_added: 3.7.0 version_added: 3.7.0
profiles: profiles:
@ -674,7 +673,6 @@ def main():
), ),
ignore_volatile_options=dict( ignore_volatile_options=dict(
type='bool', type='bool',
default=True
), ),
devices=dict( devices=dict(
type='dict', type='dict',
@ -728,13 +726,16 @@ def main():
), ),
supports_check_mode=False, supports_check_mode=False,
) )
# if module.params['ignore_volatile_options'] is None:
# module.params['ignore_volatile_options'] = True if module.params['ignore_volatile_options'] is None:
# module.deprecate( module.params['ignore_volatile_options'] = True
# 'If the keyword "volatile" is used in a playbook in the config section, a module.deprecate(
# "changed" message will appear with every run, even without a change to the playbook. 'If the keyword "volatile" is used in a playbook in the config'
# This will change in the future. 'section, a "changed" message will appear with every run, even without a change'
# Please test your scripts by "ignore_volatile_options: false"', version='5.0.0', collection_name='community.general') 'to the playbook.'
'This will change in the future. Please test your scripts'
'by "ignore_volatile_options: false". To keep the old behavior, set that option explicitly to "true"',
version='6.0.0', collection_name='community.general')
lxd_manage = LXDContainerManagement(module=module) lxd_manage = LXDContainerManagement(module=module)
lxd_manage.run() lxd_manage.run()