mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-03 04:34:24 -07:00
github_repo: deprecate force_defaults=true
This commit is contained in:
parent
77cd018427
commit
ffa4dbbb80
1 changed files with 8 additions and 5 deletions
|
@ -83,11 +83,9 @@ options:
|
||||||
version_added: "3.5.0"
|
version_added: "3.5.0"
|
||||||
force_defaults:
|
force_defaults:
|
||||||
description:
|
description:
|
||||||
- Overwrite current O(description) and O(private) attributes with defaults if set to V(true), which currently is the
|
- If V(true), overwrite current O(description) and O(private) attributes with defaults.
|
||||||
default.
|
- V(true) is deprecated for this option and will not be allowed starting in community.general 13.0.0. V(false) will be the default value then.
|
||||||
- The default for this option will be deprecated in a future version of this collection, and eventually change to V(false).
|
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
|
||||||
required: false
|
required: false
|
||||||
version_added: 4.1.0
|
version_added: 4.1.0
|
||||||
requirements:
|
requirements:
|
||||||
|
@ -252,7 +250,7 @@ def main():
|
||||||
private=dict(type='bool'),
|
private=dict(type='bool'),
|
||||||
description=dict(type='str'),
|
description=dict(type='str'),
|
||||||
api_url=dict(type='str', required=False, default='https://api.github.com'),
|
api_url=dict(type='str', required=False, default='https://api.github.com'),
|
||||||
force_defaults=dict(type='bool', default=True),
|
force_defaults=dict(type='bool'),
|
||||||
)
|
)
|
||||||
module = AnsibleModule(
|
module = AnsibleModule(
|
||||||
argument_spec=module_args,
|
argument_spec=module_args,
|
||||||
|
@ -262,6 +260,11 @@ def main():
|
||||||
mutually_exclusive=[('username', 'access_token')]
|
mutually_exclusive=[('username', 'access_token')]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if module.params['force_defaults'] is None:
|
||||||
|
module.deprecate("'force_defaults=true' is deprecated and will not be allowed in community.general 13.0.0, use 'force_defaults=false' instead",
|
||||||
|
version="13.0.0", collection_name="community.general")
|
||||||
|
module.params['force_defaults'] = True
|
||||||
|
|
||||||
if not HAS_GITHUB_PACKAGE:
|
if not HAS_GITHUB_PACKAGE:
|
||||||
module.fail_json(msg=missing_required_lib(
|
module.fail_json(msg=missing_required_lib(
|
||||||
"PyGithub"), exception=GITHUB_IMP_ERR)
|
"PyGithub"), exception=GITHUB_IMP_ERR)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue