ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-02 14:40:19 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Deprecate ec2_vpc module (#20344)

Browse source 
* Deprecate ec2_vpc module

The deprecation of ec2_vpc module has been discussed for
2 years and is causing duplication of effort as changes
are implemented for ec2_vpc rather than for the newer
alternatives

* Improve module deprecation documentation

Update the developing modules documentation with the latest
instructions on how to deprecate a module.
This commit is contained in:
Will Thames 2017-01-19 21:25:28 +10:00 • committed by John R Barker
parent acdab18ccd
commit 75a7ebe900
3 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/docsite/rst/dev_guide/developing_modules.rst
View file

@ -869,6 +869,13 @@ Deprecating and making module aliases
Starting in 1.8, you can deprecate modules by renaming them with a preceding _, i.e. old_cloud.py to
_old_cloud.py. This keeps the module available, but hides it from the primary docs and listing.
When deprecating a module, set the `ANSIBLE_METADATA` `status` to `deprecated`.
In the `DOCUMENTATION` section, add a `deprecated` field along the lines of::
deprecated: Deprecated in 2.3. Use M(whatmoduletouseinstead) instead.
Add the deprecation to CHANGELOG.md
You can also rename modules and keep an alias to the old name by using a symlink that starts with _.
This example allows the stat module to be called with fileinfo, making the following examples equivalent::