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

Changelog lint and generation bug fixes. (#53792)

Browse source 
* Add missing dict entry for changelog generation.
* Enforce str and list types on sections.
* Check type of section list items.
* Support non-ascii characters in changelogs.
This commit is contained in:
Matt Clay 2019-03-14 11:18:14 -07:00 committed by GitHub
parent e9816e10bc
commit 90a38670be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
packaging/release/changelogs/changelog.py
View file

@ -25,6 +25,7 @@ except ImportError:
argcomplete = None argcomplete = None
from ansible import constants as C from ansible import constants as C
from ansible.module_utils.six import string_types
BASE_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..')) BASE_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..'))
CHANGELOG_DIR = os.path.join(BASE_DIR, 'changelogs') CHANGELOG_DIR = os.path.join(BASE_DIR, 'changelogs')
@ -175,6 +176,8 @@ def load_plugins(version, force_reload):
LOGGER.info('refreshing plugin cache') LOGGER.info('refreshing plugin cache')
plugins_data['version'] = version plugins_data['version'] = version
plugins_data['plugins'] = {}
for plugin_type in C.DOCUMENTABLE_PLUGINS: for plugin_type in C.DOCUMENTABLE_PLUGINS:
plugins_data['plugins'][plugin_type] = json.loads(subprocess.check_output([os.path.join(BASE_DIR, 'bin', 'ansible-doc'), plugins_data['plugins'][plugin_type] = json.loads(subprocess.check_output([os.path.join(BASE_DIR, 'bin', 'ansible-doc'),
'--json', '-t', plugin_type])) '--json', '-t', plugin_type]))
@ -302,14 +305,26 @@ class ChangelogFragmentLinter(object):
errors = [] errors = []
for section, lines in fragment.content.items(): for section, lines in fragment.content.items():
if section not in self.config.sections: if section == self.config.prelude_name:
errors.append((fragment.path, 0, 0, 'invalid section: %s' % section)) if not isinstance(lines, string_types):
errors.append((fragment.path, 0, 0, 'section "%s" must be type str not %s' % (section, type(lines).__name__)))
else:
# doesn't account for prelude but only the RM should be adding those
if not isinstance(lines, list):
errors.append((fragment.path, 0, 0, 'section "%s" must be type list not %s' % (section, type(lines).__name__)))
if section not in self.config.sections:
errors.append((fragment.path, 0, 0, 'invalid section: %s' % section))
if isinstance(lines, list): if isinstance(lines, list):
for line in lines: for line in lines:
if not isinstance(line, string_types):
errors.append((fragment.path, 0, 0, 'section "%s" list items must be type str not %s' % (section, type(line).__name__)))
continue
results = rstcheck.check(line, filename=fragment.path, report_level=docutils.utils.Reporter.WARNING_LEVEL) results = rstcheck.check(line, filename=fragment.path, report_level=docutils.utils.Reporter.WARNING_LEVEL)
errors += [(fragment.path, 0, 0, result[1]) for result in results] errors += [(fragment.path, 0, 0, result[1]) for result in results]
else: elif isinstance(lines, string_types):
results = rstcheck.check(lines, filename=fragment.path, report_level=docutils.utils.Reporter.WARNING_LEVEL) results = rstcheck.check(lines, filename=fragment.path, report_level=docutils.utils.Reporter.WARNING_LEVEL)
errors += [(fragment.path, 0, 0, result[1]) for result in results] errors += [(fragment.path, 0, 0, result[1]) for result in results]