From 63b7882cbb57287e67150b7ac1e42d4e920534ee Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 6 Dec 2018 09:56:53 -0600 Subject: [PATCH] Deprecate the github_hooks module (#49296) It was super incomplete, and the interface was pretty strange; it had built-in features to handle pretty bespoke workflows ("clean504", e.g.) but was lacking lots of other useful features (like the ability to create a webhook with a shared secret). Rather than try to update the interface in a backwards compatible way, I've replaced it with the more predictable, single-purpose github_webhook and github_webhook_facts modules. --- docs/docsite/rst/porting_guides/porting_guide_2.8.rst | 1 + .../source_control/{github_hooks.py => _github_hooks.py} | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) rename lib/ansible/modules/source_control/{github_hooks.py => _github_hooks.py} (96%) diff --git a/docs/docsite/rst/porting_guides/porting_guide_2.8.rst b/docs/docsite/rst/porting_guides/porting_guide_2.8.rst index d47e14537f3..79fe5d387dd 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_2.8.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_2.8.rst @@ -96,6 +96,7 @@ The following modules will be removed in Ansible 2.12. Please update your playbo * ``foreman`` use instead. * ``katello`` use instead. +* ``github_hooks`` use :ref:`github_webhook ` and :ref:`github_webhook_facts ` instead. Noteworthy module changes diff --git a/lib/ansible/modules/source_control/github_hooks.py b/lib/ansible/modules/source_control/_github_hooks.py similarity index 96% rename from lib/ansible/modules/source_control/github_hooks.py rename to lib/ansible/modules/source_control/_github_hooks.py index df0f0f2199b..fd812f9b955 100644 --- a/lib/ansible/modules/source_control/github_hooks.py +++ b/lib/ansible/modules/source_control/_github_hooks.py @@ -9,7 +9,7 @@ __metaclass__ = type ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -17,6 +17,10 @@ DOCUMENTATION = ''' --- module: github_hooks short_description: Manages GitHub service hooks. +deprecated: + removed_in: "2.12" + why: Replaced by more granular modules + alternative: Use M(github_webhook) and M(github_webhook_facts) instead. description: - Adds service hooks and removes service hooks that have an error status. version_added: "1.4"