mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-03-26 21:33:12 +00:00
github_repo: deprecate force_defaults=true (#10435)
* github_repo: deprecate force_defaults=true * add changelog frag
This commit is contained in:
@@ -0,0 +1,2 @@
|
||||
deprecated_features:
|
||||
- github_repo - deprecate ``force_defaults=true`` (https://github.com/ansible-collections/community.general/pull/10435).
|
||||
@@ -83,11 +83,9 @@ options:
|
||||
version_added: "3.5.0"
|
||||
force_defaults:
|
||||
description:
|
||||
- Overwrite current O(description) and O(private) attributes with defaults if set to V(true), which currently is the
|
||||
default.
|
||||
- The default for this option will be deprecated in a future version of this collection, and eventually change to V(false).
|
||||
- If V(true), overwrite current O(description) and O(private) attributes with defaults.
|
||||
- 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.
|
||||
type: bool
|
||||
default: true
|
||||
required: false
|
||||
version_added: 4.1.0
|
||||
requirements:
|
||||
@@ -252,7 +250,7 @@ def main():
|
||||
private=dict(type='bool'),
|
||||
description=dict(type='str'),
|
||||
api_url=dict(type='str', default='https://api.github.com'),
|
||||
force_defaults=dict(type='bool', default=True),
|
||||
force_defaults=dict(type='bool'),
|
||||
)
|
||||
module = AnsibleModule(
|
||||
argument_spec=module_args,
|
||||
@@ -262,6 +260,11 @@ def main():
|
||||
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:
|
||||
module.fail_json(msg=missing_required_lib(
|
||||
"PyGithub"), exception=GITHUB_IMP_ERR)
|
||||
|
||||
Reference in New Issue
Block a user