From 64f74e122834b069b9fb5171a503a25a13fbe139 Mon Sep 17 00:00:00 2001
From: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Date: Tue, 30 May 2023 04:52:02 +1200
Subject: [PATCH] cpanm: deprecate default mode (#6512)
* cpanm: deprecate default mode
* add changelog frag
---
changelogs/fragments/6512-cpanm-default-mode.yml | 2 ++
plugins/modules/cpanm.py | 12 ++++++++++--
2 files changed, 12 insertions(+), 2 deletions(-)
create mode 100644 changelogs/fragments/6512-cpanm-default-mode.yml
diff --git a/changelogs/fragments/6512-cpanm-default-mode.yml b/changelogs/fragments/6512-cpanm-default-mode.yml
new file mode 100644
index 0000000000..55490905a1
--- /dev/null
+++ b/changelogs/fragments/6512-cpanm-default-mode.yml
@@ -0,0 +1,2 @@
+deprecated_features:
+ - cpanm - value ``compatibility`` is deprecated as default for parameter ``mode`` (https://github.com/ansible-collections/community.general/pull/6512).
diff --git a/plugins/modules/cpanm.py b/plugins/modules/cpanm.py
index 6260992dfe..c78d58d12b 100644
--- a/plugins/modules/cpanm.py
+++ b/plugins/modules/cpanm.py
@@ -68,9 +68,9 @@ options:
mode:
description:
- Controls the module behavior. See notes below for more details.
+ - Default is C(compatibility) but that behavior is deprecated and will be changed to C(new) in community.general 9.0.0.
type: str
choices: [compatibility, new]
- default: compatibility
version_added: 3.0.0
name_check:
description:
@@ -158,7 +158,7 @@ class CPANMinus(ModuleHelper):
mirror_only=dict(type='bool', default=False),
installdeps=dict(type='bool', default=False),
executable=dict(type='path'),
- mode=dict(type='str', choices=['compatibility', 'new'], default='compatibility'),
+ mode=dict(type='str', choices=['compatibility', 'new']),
name_check=dict(type='str')
),
required_one_of=[('name', 'from_path')],
@@ -176,6 +176,14 @@ class CPANMinus(ModuleHelper):
def __init_module__(self):
v = self.vars
+ if v.mode is None:
+ self.deprecate(
+ "The default value 'compatibility' for parameter 'mode' is being deprecated "
+ "and it will be replaced by 'new'",
+ version="9.0.0",
+ collection_name="community.general"
+ )
+ v.mode = "compatibility"
if v.mode == "compatibility":
if v.name_check:
self.do_raise("Parameter name_check can only be used with mode=new")