mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02: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()
```
|
||
|---|---|---|
| .. | ||
| group_vars | ||
| host_vars | ||
| roles | ||
| targets | ||
| asa.yaml | ||
| cloud-config-aws.yml.template | ||
| cloud-config-azure.yml.template | ||
| cloud-config-cs.ini.template | ||
| dellos6.yaml | ||
| dellos9.yaml | ||
| dellos10.yaml | ||
| eos.yaml | ||
| integration.cfg | ||
| integration_config.yml | ||
| inventory | ||
| inventory.network | ||
| inventory.networking.template | ||
| inventory.remote.template | ||
| inventory.winrm.template | ||
| ios.yaml | ||
| iosxr.yaml | ||
| junos.yaml | ||
| network-all.yaml | ||
| network-integration.cfg | ||
| nxos.yaml | ||
| ops.yaml | ||
| target-prefixes.network | ||
| vyos.yaml | ||
| windows-integration.cfg | ||