From 25163ed87ab026dc07b82ba9782f5350e6f07b27 Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Tue, 5 Aug 2025 16:12:48 +1200 Subject: [PATCH] github_repo: deprecate force_defaults=true (#10435) * github_repo: deprecate force_defaults=true * add changelog frag --- .../10435-github-repo-deprecate-force-defaults.yml | 2 ++ plugins/modules/github_repo.py | 13 ++++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 changelogs/fragments/10435-github-repo-deprecate-force-defaults.yml diff --git a/changelogs/fragments/10435-github-repo-deprecate-force-defaults.yml b/changelogs/fragments/10435-github-repo-deprecate-force-defaults.yml new file mode 100644 index 0000000000..cccb3a4c5f --- /dev/null +++ b/changelogs/fragments/10435-github-repo-deprecate-force-defaults.yml @@ -0,0 +1,2 @@ +deprecated_features: + - github_repo - deprecate ``force_defaults=true`` (https://github.com/ansible-collections/community.general/pull/10435). diff --git a/plugins/modules/github_repo.py b/plugins/modules/github_repo.py index abaddb3c28..0971e22878 100644 --- a/plugins/modules/github_repo.py +++ b/plugins/modules/github_repo.py @@ -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)