mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-22 09:18:49 +00:00
a23c95023b
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()
```
|
||
|---|---|---|
| .. | ||
| style_guide | ||
| testing | ||
| developing_api.rst | ||
| developing_core.rst | ||
| developing_inventory.rst | ||
| developing_module_utilities.rst | ||
| developing_modules.rst | ||
| developing_modules_best_practices.rst | ||
| developing_modules_checklist.rst | ||
| developing_modules_documenting.rst | ||
| developing_modules_general.rst | ||
| developing_modules_general_OLD._rst | ||
| developing_modules_general_windows.rst | ||
| developing_modules_in_groups.rst | ||
| developing_plugins.rst | ||
| developing_program_flow_modules.rst | ||
| developing_python3.rst | ||
| developing_rebasing.rst | ||
| index.rst | ||
| Makefile | ||
| overview_architecture.rst | ||
| repomerge.rst | ||
| testing.rst | ||
| testing_compile.rst | ||
| testing_httptester.rst | ||
| testing_integration.rst | ||
| testing_integration_legacy.rst | ||
| testing_pep8.rst | ||
| testing_running_locally.rst | ||
| testing_sanity.rst | ||
| testing_units.rst | ||
| testing_units_modules.rst | ||
| testing_validate-modules.rst | ||