summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorToshio Kuratomi <a.badger@gmail.com>2021-03-24 10:12:09 -0700
committerGitHub <noreply@github.com>2021-03-24 12:12:09 -0500
commitc8a78998692fd635e60d9c4babe12b0975660759 (patch)
treed618d362fc64b637e88240dad7bc49f23858dcd6
parent0543916a866c1238223f2a839fd530b96769bb71 (diff)
downloadansible-c8a78998692fd635e60d9c4babe12b0975660759.tar.gz
Update the porting guide for a new ansible version (#74016)
-rw-r--r--docs/docsite/rst/porting_guides/porting_guide_4.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/docsite/rst/porting_guides/porting_guide_4.rst b/docs/docsite/rst/porting_guides/porting_guide_4.rst
index 933a68bd0a..bda38d0aa2 100644
--- a/docs/docsite/rst/porting_guides/porting_guide_4.rst
+++ b/docs/docsite/rst/porting_guides/porting_guide_4.rst
@@ -36,6 +36,8 @@ Other:
* The configuration system now validates the ``choices`` field, so any settings that currently violate it and are currently ignored will now cause an error.
For example, `ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH=0` will now cause an error (valid choices are 'ignore', 'warn' or 'error').
* The ``ansible-galaxy`` command now uses ``resolvelib`` for resolving dependencies. In most cases this should not make a user-facing difference beyond being more performant, but we note it here for posterity and completeness.
+* Python ``module_utils`` imports may now be marked as optional during the module payload build by wrapping the ``import`` statement in a ``try`` or ``if`` block. This allows modules to use ``module_utils`` that may not be present in all versions of Ansible or a collection, and to perform arbitrary recovery or fallback actions during module runtime.
+
Deprecated
==========
@@ -84,6 +86,25 @@ Porting custom scripts
No notable changes
+Porting Guide for v4.0.0a2
+==========================
+
+Major Changes
+-------------
+
+Ansible-core
+~~~~~~~~~~~~
+
+- AnsibleModule - use ``ArgumentSpecValidator`` class for validating argument spec and remove private methods related to argument spec validation. Any modules using private methods should now use the ``ArgumentSpecValidator`` class or the appropriate validation function.
+
+Deprecated Features
+-------------------
+
+community.crypto
+~~~~~~~~~~~~~~~~
+
+- acme module_utils - the ``acme`` module_utils (``ansible_collections.community.crypto.plugins.module_utils.acme``) is deprecated and will be removed in community.crypto 2.0.0. Use the new Python modules in the ``acme`` package instead (``ansible_collections.community.crypto.plugins.module_utils.acme.xxx``) (https://github.com/ansible-collections/community.crypto/pull/184).
+
Porting Guide for v4.0.0a1
==========================