mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
e5a31e81b6
* porting-guide.py is allowed to be Python-3.6+ as it will only be run by release engineers
145 lines
3 KiB
Python
Executable file
145 lines
3 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
# coding: utf-8
|
|
# Copyright: (c) 2019, Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
import argparse
|
|
import sys
|
|
|
|
from jinja2 import Environment, DictLoader
|
|
|
|
|
|
PORTING_GUIDE_TEMPLATE = """
|
|
.. _porting_{{ ver }}_guide:
|
|
|
|
*************************
|
|
Ansible {{ ver }} Porting Guide
|
|
*************************
|
|
|
|
This section discusses the behavioral changes between Ansible {{ prev_ver }} and Ansible {{ ver }}.
|
|
|
|
It is intended to assist in updating your playbooks, plugins and other parts of your Ansible infrastructure so they will work with this version of Ansible.
|
|
|
|
We suggest you read this page along with `Ansible Changelog for {{ ver }} <https://github.com/ansible/ansible/blob/devel/changelogs/CHANGELOG-v{{ ver }}.rst>`_ to understand what updates you may need to make.
|
|
|
|
This document is part of a collection on porting. The complete list of porting guides can be found at :ref:`porting guides <porting_guides>`.
|
|
|
|
.. contents:: Topics
|
|
|
|
|
|
Playbook
|
|
========
|
|
|
|
No notable changes
|
|
|
|
|
|
Command Line
|
|
============
|
|
|
|
No notable changes
|
|
|
|
|
|
Deprecated
|
|
==========
|
|
|
|
No notable changes
|
|
|
|
|
|
Modules
|
|
=======
|
|
|
|
No notable changes
|
|
|
|
|
|
Modules removed
|
|
---------------
|
|
|
|
The following modules no longer exist:
|
|
|
|
* No notable changes
|
|
|
|
|
|
Deprecation notices
|
|
-------------------
|
|
|
|
No notable changes
|
|
|
|
|
|
Noteworthy module changes
|
|
-------------------------
|
|
|
|
No notable changes
|
|
|
|
|
|
Plugins
|
|
=======
|
|
|
|
No notable changes
|
|
|
|
|
|
Porting custom scripts
|
|
======================
|
|
|
|
No notable changes
|
|
|
|
|
|
Networking
|
|
==========
|
|
|
|
No notable changes
|
|
|
|
""" # noqa for E501 (line length).
|
|
# jinja2 is horrid about getting rid of extra newlines so we have to have a single line per
|
|
# paragraph for proper wrapping to occur
|
|
|
|
JINJA_ENV = Environment(
|
|
loader=DictLoader({'porting_guide': PORTING_GUIDE_TEMPLATE,
|
|
}),
|
|
extensions=['jinja2.ext.i18n'],
|
|
trim_blocks=True,
|
|
lstrip_blocks=True,
|
|
)
|
|
|
|
|
|
def parse_args(args):
|
|
parser = argparse.ArgumentParser(description="Generate a fresh porting guide template")
|
|
parser.add_argument("--version", dest="version", type=str, required=True, action='store',
|
|
help="Version of Ansible to write the porting guide for")
|
|
|
|
args = parser.parse_args(args)
|
|
|
|
return args
|
|
|
|
|
|
def generate_porting_guide(version):
|
|
template = JINJA_ENV.get_template('porting_guide')
|
|
|
|
version_list = version.split('.')
|
|
version_list[-1] = str(int(version_list[-1]) - 1)
|
|
previous_version = '.'.join(version_list)
|
|
|
|
content = template.render(ver=version, prev_ver=previous_version)
|
|
return content
|
|
|
|
|
|
def write_guide(version, guide_content):
|
|
filename = f'porting_guide_{version}.rst'
|
|
with open(filename, 'w') as out_file:
|
|
out_file.write(guide_content)
|
|
|
|
|
|
def main():
|
|
args = parse_args(sys.argv[1:])
|
|
|
|
guide_content = generate_porting_guide(args.version)
|
|
|
|
write_guide(args.version, guide_content)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|