From 6f60692dd17926499ba7723ccd026501c6fa4ff4 Mon Sep 17 00:00:00 2001
From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com>
Date: Sat, 20 Apr 2024 10:20:48 +0200
Subject: [PATCH] [PR #8189/1bbef588 backport][stable-8] Deprecate hipchat
 callback (#8240)

Deprecate hipchat callback (#8189)

* Deprecate hipchat callback.

* Avoid duplicate 'callback' key.

(cherry picked from commit 1bbef5884488901a7e5e50c719e2d97c1c9452d6)

Co-authored-by: Felix Fontein <felix@fontein.de>
---
 changelogs/fragments/hipchat.yml |  4 ++++
 meta/runtime.yml                 | 40 ++++++++++++++++++--------------
 plugins/callback/hipchat.py      |  4 ++++
 3 files changed, 30 insertions(+), 18 deletions(-)
 create mode 100644 changelogs/fragments/hipchat.yml

diff --git a/changelogs/fragments/hipchat.yml b/changelogs/fragments/hipchat.yml
new file mode 100644
index 0000000000..0260c09c84
--- /dev/null
+++ b/changelogs/fragments/hipchat.yml
@@ -0,0 +1,4 @@
+deprecated_features:
+  - "hipchat callback plugin - the hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020.
+     The callback plugin is therefore deprecated and will be removed from community.general 10.0.0 if nobody provides compelling reasons to still keep it
+     (https://github.com/ansible-collections/community.general/issues/8184, https://github.com/ansible-collections/community.general/pull/8189)."
diff --git a/meta/runtime.yml b/meta/runtime.yml
index 4fe80ca257..a9354aab39 100644
--- a/meta/runtime.yml
+++ b/meta/runtime.yml
@@ -13,6 +13,28 @@ action_groups:
     - consul_session
     - consul_token
 plugin_routing:
+  callback:
+    actionable:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the 'default' callback plugin with 'display_skipped_hosts
+          = no' and 'display_ok_hosts = no' options.
+    full_skip:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the 'default' callback plugin with 'display_skipped_hosts
+          = no' option.
+    hipchat:
+      deprecation:
+        removal_version: 10.0.0
+        warning_text: The hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020.
+    osx_say:
+      redirect: community.general.say
+    stderr:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the 'default' callback plugin with 'display_failed_stderr
+          = yes' option.
   connection:
     docker:
       redirect: community.docker.docker
@@ -4707,24 +4729,6 @@ plugin_routing:
       redirect: dellemc.openmanage.dellemc_idrac
     remote_management.dellemc.ome:
       redirect: dellemc.openmanage.ome
-  callback:
-    actionable:
-      tombstone:
-        removal_version: 2.0.0
-        warning_text: Use the 'default' callback plugin with 'display_skipped_hosts
-          = no' and 'display_ok_hosts = no' options.
-    full_skip:
-      tombstone:
-        removal_version: 2.0.0
-        warning_text: Use the 'default' callback plugin with 'display_skipped_hosts
-          = no' option.
-    osx_say:
-      redirect: community.general.say
-    stderr:
-      tombstone:
-        removal_version: 2.0.0
-        warning_text: Use the 'default' callback plugin with 'display_failed_stderr
-          = yes' option.
   inventory:
     docker_machine:
       redirect: community.docker.docker_machine
diff --git a/plugins/callback/hipchat.py b/plugins/callback/hipchat.py
index 3e10b69e7f..afd9e20559 100644
--- a/plugins/callback/hipchat.py
+++ b/plugins/callback/hipchat.py
@@ -18,6 +18,10 @@ DOCUMENTATION = '''
     description:
       - This callback plugin sends status updates to a HipChat channel during playbook execution.
       - Before 2.4 only environment variables were available for configuring this plugin.
+    deprecated:
+      removed_in: 10.0.0
+      why: The hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020.
+      alternative: There is none.
     options:
       token:
         description: HipChat API token for v1 or v2 API.