Deprecate the github_hooks module ()

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.
This commit is contained in:
Chris St. Pierre 2018-12-06 09:56:53 -06:00 committed by John R Barker
parent 69d230f4bf
commit 63b7882cbb
2 changed files with 6 additions and 1 deletions
docs/docsite/rst/porting_guides
lib/ansible/modules/source_control

View file

@ -96,6 +96,7 @@ The following modules will be removed in Ansible 2.12. Please update your playbo
* ``foreman`` use <https://github.com/theforeman/foreman-ansible-modules> instead.
* ``katello`` use <https://github.com/theforeman/foreman-ansible-modules> instead.
* ``github_hooks`` use :ref:`github_webhook <github_webhook_module>` and :ref:`github_webhook_facts <github_webhook_facts_module>` instead.
Noteworthy module changes

View file

@ -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"