community.general/lib/ansible/modules/utilities/logic
John R Barker a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
2018-01-30 12:23:52 +00:00
..
__init__.py
_include.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
assert.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
async_status.py Temporary (#31677) 2018-01-15 21:15:04 -08:00
async_wrapper.py Temporary (#31677) 2018-01-15 21:15:04 -08:00
debug.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
fail.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
import_playbook.py Unifying wording and formatting of all include and import modules (#31938) 2017-11-22 14:05:29 -08:00
import_role.py Small correction to import_role documentation (#33285) 2017-12-01 20:58:31 +10:00
import_tasks.py Add module support to yamllint sanity test. (#34964) 2018-01-16 15:08:56 -08:00
include_role.py Unifying wording and formatting of all include and import modules (#31938) 2017-11-22 14:05:29 -08:00
include_tasks.py Unifying wording and formatting of all include and import modules (#31938) 2017-11-22 14:05:29 -08:00
include_vars.py Unifying wording and formatting of all include and import modules (#31938) 2017-11-22 14:05:29 -08:00
pause.py Add echo option to pause module (#32205) 2017-11-03 13:32:36 -04:00
set_fact.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
set_stats.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
wait_for.py fix ci, duplicate exception checking was merged in wait_for (my fault) 2017-12-13 09:53:39 -08:00
wait_for_connection.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00