mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-24 21:14:00 -07:00
a23c95023bEnforce 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()
```
|
||
|---|---|---|
| .. | ||
| cli_rst.j2 | ||
| config.rst.j2 | ||
| list_of_CATEGORY_modules.rst.j2 | ||
| list_of_CATEGORY_plugins.rst.j2 | ||
| man.j2 | ||
| modules_by_category.rst.j2 | ||
| modules_by_support.rst.j2 | ||
| playbooks_keywords.rst.j2 | ||
| plugin.rst.j2 | ||
| plugins_by_category.rst.j2 | ||
| plugins_by_support.rst.j2 | ||