mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-27 06:09:37 -07:00
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()
```
|
||
|---|---|---|
| .. | ||
| __init__.py | ||
| _azure.py | ||
| azure_rm_acs.py | ||
| azure_rm_availabilityset.py | ||
| azure_rm_availabilityset_facts.py | ||
| azure_rm_containerinstance.py | ||
| azure_rm_containerregistry.py | ||
| azure_rm_deployment.py | ||
| azure_rm_dnsrecordset.py | ||
| azure_rm_dnsrecordset_facts.py | ||
| azure_rm_dnszone.py | ||
| azure_rm_dnszone_facts.py | ||
| azure_rm_functionapp.py | ||
| azure_rm_functionapp_facts.py | ||
| azure_rm_image.py | ||
| azure_rm_loadbalancer.py | ||
| azure_rm_loadbalancer_facts.py | ||
| azure_rm_managed_disk.py | ||
| azure_rm_managed_disk_facts.py | ||
| azure_rm_mysqldatabase.py | ||
| azure_rm_mysqlserver.py | ||
| azure_rm_networkinterface.py | ||
| azure_rm_networkinterface_facts.py | ||
| azure_rm_postgresqldatabase.py | ||
| azure_rm_postgresqlserver.py | ||
| azure_rm_publicipaddress.py | ||
| azure_rm_publicipaddress_facts.py | ||
| azure_rm_resourcegroup.py | ||
| azure_rm_resourcegroup_facts.py | ||
| azure_rm_securitygroup.py | ||
| azure_rm_securitygroup_facts.py | ||
| azure_rm_sqldatabase.py | ||
| azure_rm_sqlserver.py | ||
| azure_rm_sqlserver_facts.py | ||
| azure_rm_storageaccount.py | ||
| azure_rm_storageaccount_facts.py | ||
| azure_rm_storageblob.py | ||
| azure_rm_subnet.py | ||
| azure_rm_virtualmachine.py | ||
| azure_rm_virtualmachine_extension.py | ||
| azure_rm_virtualmachine_scaleset.py | ||
| azure_rm_virtualmachine_scaleset_facts.py | ||
| azure_rm_virtualmachineimage_facts.py | ||
| azure_rm_virtualnetwork.py | ||
| azure_rm_virtualnetwork_facts.py | ||