ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Code to limit display of version_added attributions in modules for modules that are too old to call out this information.

Browse source 
This does not generically apply to new arguments added to existing modules, just the version_added attribute on the top level modules.
This commit is contained in:
Michael DeHaan 2013-11-27 21:34:00 -05:00
parent 36effd237c
commit 40429ee64e
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
hacking/module_formatter.py
View file

@ -34,6 +34,10 @@ import cgi
import ansible.utils import ansible.utils
import ansible.utils.module_docs as module_docs import ansible.utils.module_docs as module_docs
# if a module is added in a version of Ansible older than this, don't print the version added information
# in the module documentation because everyone is assumed to be running something newer than this already.
TO_OLD_TO_BE_NOTABLE = 1.0
# Get parent directory of the directory this script lives in # Get parent directory of the directory this script lives in
MODULEDIR=os.path.abspath(os.path.join( MODULEDIR=os.path.abspath(os.path.join(
os.path.dirname(os.path.realpath(__file__)), os.pardir, 'library' os.path.dirname(os.path.realpath(__file__)), os.pardir, 'library'
@ -366,8 +370,20 @@ def main():
if not 'version_added' in doc: if not 'version_added' in doc:
sys.stderr.write("*** ERROR: missing version_added in: %s ***\n" % module) sys.stderr.write("*** ERROR: missing version_added in: %s ***\n" % module)
sys.exit(1) sys.exit(1)
added = 0
if doc['version_added'] == 'historical': if doc['version_added'] == 'historical':
del doc['version_added'] del doc['version_added']
else:
added = doc['version_added']
# don't show version added information if it's too old to be called out
if added:
added_tokens = str(added).split(".")
added = added_tokens[0] + "." + added_tokens[1]
added_float = float(added)
if added and added_float < TO_OLD_TO_BE_NOTABLE:
del doc['version_added']
for (k,v) in doc['options'].iteritems(): for (k,v) in doc['options'].iteritems():
all_keys.append(k) all_keys.append(k)