[PR #10490/88bd44ae backport][stable-11] rocketchat: deprecate default value of is_pre740 (#10597)

rocketchat: deprecate default value of is_pre740 (#10490)

* Deprecate default value of is_pre740.

* Use correct markup.



---------


(cherry picked from commit 88bd44aea7)

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

changelogs/fragments/10490-rocketchat.yml

@@ -0,0 +1,3 @@
+deprecated_features:
+  - "rocketchat - the default value for ``is_pre740``, currently ``true``, is deprecated and will change to ``false`` in community.general 13.0.0
+     (https://github.com/ansible-collections/community.general/pull/10490)."

plugins/modules/rocketchat.py

@@ -104,10 +104,9 @@ options:
     description:
       - If V(true), the payload matches Rocket.Chat prior to 7.4.0 format. This format has been used by the module since its
         inception, but is no longer supported by Rocket.Chat 7.4.0.
-      - The default value of the option is going to change to V(false) eventually.
+      - The default value of the option, V(true), is B(deprecated) since community.general 11.2.0 and will change to V(false) in community.general 13.0.0.
       - This parameter is going to be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version.
     type: bool
-    default: true
     version_added: 10.5.0
 """
 
@@ -230,7 +229,7 @@ def main():
             validate_certs=dict(default=True, type='bool'),
             color=dict(type='str', default='normal', choices=['normal', 'good', 'warning', 'danger']),
             attachments=dict(type='list', elements='dict'),
-            is_pre740=dict(default=True, type='bool')
+            is_pre740=dict(type='bool')
         )
     )
 
@@ -247,6 +246,15 @@ def main():
     attachments = module.params['attachments']
     is_pre740 = module.params['is_pre740']
 
+    if is_pre740 is None:
+        module.deprecate(
+            "The default value 'true' for 'is_pre740' is deprecated and will change to 'false' in community.general 13.0.0."
+            " You can explicitly set 'is_pre740' in your task to avoid this deprecation warning",
+            version="13.0.0",
+            collection_name="community.general",
+        )
+        is_pre740 = True
+
     payload = build_payload_for_rocketchat(module, text, channel, username, icon_url, icon_emoji, link_names, color, attachments, is_pre740)
     do_notify_rocketchat(module, domain, token, protocol, payload)