mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
puppet: Add documentation and remove deprecation for show_diff, keep deprecation for alias show-diff (#3980)
* puppet: Add documentation and remove deprecation for show_diff
* Add changelog fragment
* Update changelogs/fragments/3980-puppet-show_diff.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/system/puppet.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/system/puppet.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Fixing syntax error introduced in 29298da3
* More documentation for show_diff and fix some sanity errors
* Update changelogs/fragments/3980-puppet-show_diff.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update tests/sanity/ignore-2.10.txt
Co-authored-by: Felix Fontein <felix@fontein.de>
* Add validate-modules:parameter-invalid to ignores due to invalid and depricated alias
* Keep use-argspec-type-path in ignores
* Update plugins/modules/system/puppet.py
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Benoit Vaudel <benoit@catalyst.net.nz>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Benoit Vaudel
GitHub
parent
d19ab93faf
commit
fe57cd5ac8
7 changed files with 16 additions and 10 deletions
2
changelogs/fragments/3980-puppet-show_diff.yml
Normal file
2
changelogs/fragments/3980-puppet-show_diff.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
minor_changes:
|
||||
- puppet - remove deprecation for ``show_diff`` parameter. Its alias ``show-diff`` is still deprecated and will be removed in community.general 7.0.0 (https://github.com/ansible-collections/community.general/pull/3980).
|
||||
|
|
@ -92,6 +92,13 @@ options:
|
|||
- Enable full debugging.
|
||||
type: bool
|
||||
default: false
|
||||
show_diff:
|
||||
description:
|
||||
- Whether to print file changes details
|
||||
- Alias C(show-diff) has been deprecated and will be removed in community.general 7.0.0.
|
||||
aliases: ['show-diff']
|
||||
type: bool
|
||||
default: false
|
||||
requirements:
|
||||
- puppet
|
||||
author:
|
||||
|
|
@ -174,9 +181,10 @@ def main():
|
|||
manifest=dict(type='str'),
|
||||
noop=dict(type='bool'),
|
||||
logdest=dict(type='str', default='stdout', choices=['all', 'stdout', 'syslog']),
|
||||
# The following is not related to Ansible's diff; see https://github.com/ansible-collections/community.general/pull/3980#issuecomment-1005666154
|
||||
show_diff=dict(
|
||||
type='bool', default=False, aliases=['show-diff'],
|
||||
removed_in_version='7.0.0', removed_from_collection='community.general'),
|
||||
deprecated_aliases=[dict(name='show-diff', version='7.0.0', collection_name='community.general')]),
|
||||
facts=dict(type='dict'),
|
||||
facter_basename=dict(type='str', default='ansible'),
|
||||
environment=dict(type='str'),
|
||||
|
|
|
|||
|
|
@ -48,8 +48,7 @@ plugins/modules/system/iptables_state.py validate-modules:undocumented-parameter
|
|||
plugins/modules/system/osx_defaults.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/parted.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/puppet.py use-argspec-type-path
|
||||
plugins/modules/system/puppet.py validate-modules:doc-default-does-not-match-spec # show_diff is not documented
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-invalid # invalid alias - removed in 7.0.0
|
||||
plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
|
||||
plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice # state get removed in 5.0.0
|
||||
plugins/modules/system/xfconf.py validate-modules:return-syntax-error
|
||||
|
|
|
|||
|
|
@ -47,8 +47,7 @@ plugins/modules/system/iptables_state.py validate-modules:undocumented-parameter
|
|||
plugins/modules/system/osx_defaults.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/parted.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/puppet.py use-argspec-type-path
|
||||
plugins/modules/system/puppet.py validate-modules:doc-default-does-not-match-spec # show_diff is not documented
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-invalid # invalid alias - removed in 7.0.0
|
||||
plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
|
||||
plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice # state get removed in 5.0.0
|
||||
plugins/modules/system/xfconf.py validate-modules:return-syntax-error
|
||||
|
|
|
|||
|
|
@ -42,8 +42,7 @@ plugins/modules/system/iptables_state.py validate-modules:undocumented-parameter
|
|||
plugins/modules/system/osx_defaults.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/parted.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/puppet.py use-argspec-type-path
|
||||
plugins/modules/system/puppet.py validate-modules:doc-default-does-not-match-spec # show_diff is not documented
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-invalid # invalid alias - removed in 7.0.0
|
||||
plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
|
||||
plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice # state get removed in 5.0.0
|
||||
plugins/modules/system/xfconf.py validate-modules:return-syntax-error
|
||||
|
|
|
|||
|
|
@ -42,8 +42,7 @@ plugins/modules/system/iptables_state.py validate-modules:undocumented-parameter
|
|||
plugins/modules/system/osx_defaults.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/parted.py validate-modules:parameter-state-invalid-choice
|
||||
plugins/modules/system/puppet.py use-argspec-type-path
|
||||
plugins/modules/system/puppet.py validate-modules:doc-default-does-not-match-spec # show_diff is not documented
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-invalid # invalid alias - removed in 7.0.0
|
||||
plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
|
||||
plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice # state get removed in 5.0.0
|
||||
plugins/modules/system/xfconf.py validate-modules:return-syntax-error
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ plugins/modules/remote_management/manageiq/manageiq_provider.py validate-modules
|
|||
plugins/modules/source_control/github/github_deploy_key.py validate-modules:parameter-invalid
|
||||
plugins/modules/system/iptables_state.py validate-modules:undocumented-parameter
|
||||
plugins/modules/system/puppet.py use-argspec-type-path
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/system/puppet.py validate-modules:parameter-invalid # invalid alias - removed in 7.0.0
|
||||
plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path
|
||||
plugins/modules/system/xfconf.py validate-modules:return-syntax-error
|
||||
plugins/modules/web_infrastructure/jenkins_plugin.py use-argspec-type-path
|
||||
|
|
|
|||
Loading…
Reference in a new issue