New release v2.18.3 (#84745)

(cherry picked from commit a086c34a91)

.azure-pipelines/azure-pipelines.yml

@@ -27,14 +27,11 @@ variables:
   - name: coverageBranches
     value: devel
   - name: entryPoint
-    value: test/utils/shippable/shippable.sh
+    value: .azure-pipelines/commands/entry-point.sh
   - name: fetchDepth
     value: 500
-
-resources:
-  containers:
-    - container: default
-      image: quay.io/ansible/azure-pipelines-test-container:1.9.0
+  - name: defaultContainer
+    value: quay.io/ansible/azure-pipelines-test-container:6.0.0
 
 pool: Standard
 
@@ -49,9 +46,6 @@ stages:
           targets:
             - test: 1
             - test: 2
-            - test: 3
-            - test: 4
-            - test: 5
   - stage: Units
     dependsOn: []
     jobs:
@@ -60,14 +54,12 @@ stages:
           nameFormat: Python {0}
           testFormat: units/{0}
           targets:
-            - test: 2.6
-            - test: 2.7
-            - test: 3.5
-            - test: 3.6
-            - test: 3.7
             - test: 3.8
             - test: 3.9
             - test: '3.10'
+            - test: 3.11
+            - test: 3.12
+            - test: 3.13
   - stage: Windows
     dependsOn: []
     jobs:
@@ -76,63 +68,92 @@ stages:
           nameFormat: Server {0}
           testFormat: windows/{0}/1
           targets:
-            - test: 2012
-            - test: 2012-R2
-            - test: 2016
-            - test: 2019
-            - test: 2022
+            - name: 2016 WinRM HTTP
+              test: 2016/winrm/http
+            - name: 2019 WinRM HTTPS
+              test: 2019/winrm/https
+            - name: 2022 WinRM HTTPS
+              test: 2022/winrm/https
+            - name: 2022 PSRP HTTP
+              test: 2022/psrp/http
+            - name: 2022 SSH Key
+              test: 2022/ssh/key
   - stage: Remote
     dependsOn: []
     jobs:
-      - template: templates/matrix.yml
+      - template: templates/matrix.yml  # context/target
         parameters:
           targets:
-            - name: macOS 11.1
-              test: macos/11.1
-            - name: RHEL 7.9
-              test: rhel/7.9
-            - name: RHEL 8.4 py36
-              test: rhel/8.4@3.6
-            - name: RHEL 8.4 py38
-              test: rhel/8.4@3.8
-            - name: FreeBSD 12.2
-              test: freebsd/12.2
-            - name: FreeBSD 13.0
-              test: freebsd/13.0
+            - name: macOS 14.3
+              test: macos/14.3
+            - name: RHEL 9.4 py39
+              test: rhel/9.4@3.9
+            - name: RHEL 9.4 py312
+              test: rhel/9.4@3.12
+            - name: FreeBSD 13.3
+              test: freebsd/13.3
+            - name: FreeBSD 14.1
+              test: freebsd/14.1
           groups:
             - 1
             - 2
+      - template: templates/matrix.yml  # context/controller
+        parameters:
+          targets:
+            - name: macOS 14.3
+              test: macos/14.3
+            - name: RHEL 9.4
+              test: rhel/9.4
+            - name: FreeBSD 13.3
+              test: freebsd/13.3
+            - name: FreeBSD 14.1
+              test: freebsd/14.1
+          groups:
             - 3
             - 4
             - 5
+      - template: templates/matrix.yml  # context/controller (ansible-test container management)
+        parameters:
+          targets:
+            - name: Alpine 3.20
+              test: alpine/3.20
+            - name: Fedora 40
+              test: fedora/40
+            - name: RHEL 9.4
+              test: rhel/9.4
+            - name: Ubuntu 24.04
+              test: ubuntu/24.04
+          groups:
+            - 6
   - stage: Docker
     dependsOn: []
     jobs:
-      - template: templates/matrix.yml
+      - template: templates/matrix.yml  # context/target
         parameters:
           testFormat: linux/{0}
           targets:
-            - name: Alpine 3
-              test: alpine3
-            - name: CentOS 6
-              test: centos6
-            - name: CentOS 7
-              test: centos7
-            - name: Fedora 33
-              test: fedora33
-            - name: Fedora 34
-              test: fedora34
-            - name: openSUSE 15 py2
-              test: opensuse15py2
-            - name: openSUSE 15 py3
-              test: opensuse15
-            - name: Ubuntu 18.04
-              test: ubuntu1804
-            - name: Ubuntu 20.04
-              test: ubuntu2004
+            - name: Alpine 3.20
+              test: alpine320
+            - name: Fedora 40
+              test: fedora40
+            - name: Ubuntu 22.04
+              test: ubuntu2204
+            - name: Ubuntu 24.04
+              test: ubuntu2404
           groups:
             - 1
             - 2
+      - template: templates/matrix.yml  # context/controller
+        parameters:
+          testFormat: linux/{0}
+          targets:
+            - name: Alpine 3.20
+              test: alpine320
+            - name: Fedora 40
+              test: fedora40
+            - name: Ubuntu 24.04
+              test: ubuntu2404
+          groups:
             - 3
             - 4
             - 5
@@ -144,9 +165,9 @@ stages:
           nameFormat: Python {0}
           testFormat: galaxy/{0}/1
           targets:
-            - test: 3.8
-            - test: 3.9
-            - test: '3.10'
+            - test: 3.11
+            - test: 3.12
+            - test: 3.13
   - stage: Generic
     dependsOn: []
     jobs:
@@ -155,53 +176,9 @@ stages:
           nameFormat: Python {0}
           testFormat: generic/{0}/1
           targets:
-            - test: 3.8
-            - test: 3.9
-            - test: '3.10'
-  - stage: Incidental_Remote
-    displayName: Incidental Remote
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: i/{0}
-          targets:
-            - name: macOS 11.1
-              test: macos/11.1
-            - name: RHEL 7.9
-              test: rhel/7.9
-            - name: RHEL 8.4 py36
-              test: rhel/8.4@3.6
-            - name: RHEL 8.4 py38
-              test: rhel/8.4@3.8
-            - name: FreeBSD 12.2
-              test: freebsd/12.2
-            - name: FreeBSD 13.0
-              test: freebsd/13.0
-  - stage: Incidental_Docker
-    displayName: Incidental Docker
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: i/linux/{0}
-          targets:
-            - name: CentOS 6
-              test: centos6
-            - name: CentOS 7
-              test: centos7
-            - name: Fedora 33
-              test: fedora33
-            - name: Fedora 34
-              test: fedora34
-            - name: openSUSE 15 py2
-              test: opensuse15py2
-            - name: openSUSE 15 py3
-              test: opensuse15
-            - name: Ubuntu 18.04
-              test: ubuntu1804
-            - name: Ubuntu 20.04
-              test: ubuntu2004
+            - test: 3.11
+            - test: 3.12
+            - test: 3.13
   - stage: Incidental_Windows
     displayName: Incidental Windows
     dependsOn: []
@@ -211,11 +188,16 @@ stages:
           nameFormat: Server {0}
           testFormat: i/windows/{0}
           targets:
-            - test: 2012
-            - test: 2012-R2
-            - test: 2016
-            - test: 2019
-            - test: 2022
+            - name: 2016 WinRM HTTP
+              test: 2016/winrm/http
+            - name: 2019 WinRM HTTPS
+              test: 2019/winrm/https
+            - name: 2022 WinRM HTTPS
+              test: 2022/winrm/https
+            - name: 2022 PSRP HTTP
+              test: 2022/psrp/http
+            - name: 2022 SSH Key
+              test: 2022/ssh/key
   - stage: Incidental
     dependsOn: []
     jobs:
@@ -225,14 +207,6 @@ stages:
           targets:
             - name: IOS Python
               test: ios/csr1000v/
-            - name: VyOS Python
-              test: vyos/1.1.8/
-            - name: AWS Python 2.7
-              test: aws/2.7
-            - name: AWS Python 3.6
-              test: aws/3.6
-            - name: Cloud Python
-              test: cloud/
   - stage: Summary
     condition: succeededOrFailed()
     dependsOn:
@@ -243,8 +217,6 @@ stages:
       - Docker
       - Galaxy
       - Generic
-      - Incidental_Remote
-      - Incidental_Docker
       - Incidental_Windows
       - Incidental
     jobs:

.azure-pipelines/commands/entry-point.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+set -o pipefail -eux
+
+declare -a args
+IFS='/:' read -ra args <<< "$1"
+
+script="${args[0]}"
+
+test="$1"
+
+docker images
+docker ps
+
+for container in $(docker ps --format '{{.Image}} {{.ID}}' | grep -v -e '^quay.io/ansible/azure-pipelines-test-container:' | sed 's/^.* //'); do
+    docker rm -f "${container}" || true  # ignore errors
+done
+
+docker ps
+
+export PATH="${PWD}/bin:${PATH}"
+export PYTHONIOENCODING='utf-8'
+
+if [ -n "${COVERAGE:-}" ]; then
+    # on-demand coverage reporting triggered by setting the COVERAGE environment variable to a non-empty value
+    export COVERAGE="--coverage"
+elif [[ "${COMMIT_MESSAGE}" =~ ci_coverage ]]; then
+    # on-demand coverage reporting triggered by having 'ci_coverage' in the latest commit message
+    export COVERAGE="--coverage"
+else
+    # on-demand coverage reporting disabled (default behavior, always-on coverage reporting remains enabled)
+    export COVERAGE="--coverage-check"
+fi
+
+if [ -n "${COMPLETE:-}" ]; then
+    # disable change detection triggered by setting the COMPLETE environment variable to a non-empty value
+    export CHANGED=""
+elif [[ "${COMMIT_MESSAGE}" =~ ci_complete ]]; then
+    # disable change detection triggered by having 'ci_complete' in the latest commit message
+    export CHANGED=""
+else
+    # enable change detection (default behavior)
+    export CHANGED="--changed"
+fi
+
+if [ "${IS_PULL_REQUEST:-}" == "true" ]; then
+    # run unstable tests which are targeted by focused changes on PRs
+    export UNSTABLE="--allow-unstable-changed"
+else
+    # do not run unstable tests outside PRs
+    export UNSTABLE=""
+fi
+
+if [[ "${COVERAGE:-}" == "--coverage" ]]; then
+    timeout=60
+else
+    timeout=50
+fi
+
+ansible-test env --dump --show --timeout "${timeout}" --color -v
+
+".azure-pipelines/commands/${script}.sh" "${test}"

.azure-pipelines/commands/generic.sh

@@ -15,4 +15,4 @@ fi
 
 # shellcheck disable=SC2086
 ansible-test integration --color -v --retry-on-error "${target}" ${COVERAGE:+"$COVERAGE"} ${CHANGED:+"$CHANGED"} ${UNSTABLE:+"$UNSTABLE"} \
-    --docker default --python "${python}" --pypi-proxy
+    --docker default --python "${python}"

.azure-pipelines/commands/i.sh

@@ -11,4 +11,4 @@ script="${args[1]}"
 
 IFS='/' test="${args[*]:1}"
 
-"test/utils/shippable/incidental/${script}.sh" "${test}"
+".azure-pipelines/commands/incidental/${script}.sh" "${test}"

.azure-pipelines/commands/incidental/windows.sh

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+set -o pipefail -eux
+
+declare -a args
+IFS='/:' read -ra args <<< "$1"
+
+version="${args[1]}"
+connection="${args[2]}"
+connection_setting="${args[3]}"
+
+target="shippable/windows/incidental/"
+
+stage="${S:-prod}"
+provider="${P:-default}"
+
+# python version to run full tests on while other versions run minimal tests
+python_default="$(PYTHONPATH="${PWD}/test/lib" python -c 'from ansible_test._internal import constants; print(constants.CONTROLLER_MIN_PYTHON_VERSION)')"
+
+# version to test when only testing a single version
+single_version=2022
+
+# shellcheck disable=SC2086
+ansible-test windows-integration --list-targets -v ${CHANGED:+"$CHANGED"} ${UNSTABLE:+"$UNSTABLE"} > /tmp/explain.txt 2>&1 || { cat /tmp/explain.txt && false; }
+{ grep ' windows-integration: .* (targeted)$' /tmp/explain.txt || true; } > /tmp/windows.txt
+
+if [ -s /tmp/windows.txt ] || [ "${CHANGED:+$CHANGED}" == "" ]; then
+    echo "Detected changes requiring integration tests specific to Windows:"
+    cat /tmp/windows.txt
+
+    echo "Running Windows integration tests for the version ${version}."
+else
+    echo "No changes requiring integration tests specific to Windows were detected."
+    echo "Running Windows integration tests for a single version only: ${single_version}"
+
+    if [ "${version}" != "${single_version}" ]; then
+        echo "Skipping this job since it is for: ${version}"
+        exit 0
+    fi
+fi
+
+# shellcheck disable=SC2086
+ansible-test windows-integration --color -v --retry-on-error "${target}" ${COVERAGE:+"$COVERAGE"} ${CHANGED:+"$CHANGED"} ${UNSTABLE:+"$UNSTABLE"} \
+    --controller "docker:default,python=${python_default}" \
+    --target "remote:windows/${version},connection=${connection}+${connection_setting},provider=${provider}" \
+    --remote-terminate always --remote-stage "${stage}"

.azure-pipelines/commands/sanity.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+set -o pipefail -eux
+
+declare -a args
+IFS='/:' read -ra args <<< "$1"
+
+group="${args[1]}"
+
+group2_include=(
+    ansible-doc
+    changelog
+    package-data
+    pep8
+    pylint
+    validate-modules
+)
+
+group1_exclude=(
+    "${group2_include[@]}"
+)
+
+options=()
+
+case "${group}" in
+    1)
+        for name in "${group1_exclude[@]}"; do
+            options+=(--skip-test "${name}")
+        done
+        ;;
+    2)
+        for name in "${group2_include[@]}"; do
+            options+=(--test "${name}")
+        done
+        ;;
+esac
+
+# shellcheck disable=SC2086
+ansible-test sanity --color -v --junit ${COVERAGE:+"$COVERAGE"} ${CHANGED:+"$CHANGED"} \
+    --docker \
+    "${options[@]}" --allow-disabled

.azure-pipelines/commands/windows.sh

@@ -0,0 +1,89 @@
+#!/usr/bin/env bash
+
+set -o pipefail -eux
+
+declare -a args
+IFS='/:' read -ra args <<< "$1"
+
+version="${args[1]}"
+connection="${args[2]}"
+connection_setting="${args[3]}"
+group="${args[4]}"
+
+target="shippable/windows/group${group}/"
+
+stage="${S:-prod}"
+provider="${P:-default}"
+
+# python versions to test in order
+IFS=' ' read -r -a python_versions <<< \
+    "$(PYTHONPATH="${PWD}/test/lib" python -c 'from ansible_test._internal import constants; print(" ".join(constants.CONTROLLER_PYTHON_VERSIONS))')"
+
+# python version to run full tests on while other versions run minimal tests
+python_default="$(PYTHONPATH="${PWD}/test/lib" python -c 'from ansible_test._internal import constants; print(constants.CONTROLLER_MIN_PYTHON_VERSION)')"
+
+# version to test when only testing a single version
+single_version=2022
+
+# shellcheck disable=SC2086
+ansible-test windows-integration --list-targets -v ${CHANGED:+"$CHANGED"} ${UNSTABLE:+"$UNSTABLE"} > /tmp/explain.txt 2>&1 || { cat /tmp/explain.txt && false; }
+{ grep ' windows-integration: .* (targeted)$' /tmp/explain.txt || true; } > /tmp/windows.txt
+
+if [ -s /tmp/windows.txt ] || [ "${CHANGED:+$CHANGED}" == "" ]; then
+    echo "Detected changes requiring integration tests specific to Windows:"
+    cat /tmp/windows.txt
+
+    echo "Running Windows integration tests for the version ${version}."
+else
+    echo "No changes requiring integration tests specific to Windows were detected."
+    echo "Running Windows integration tests for a single version only: ${single_version}"
+
+    if [ "${version}" != "${single_version}" ]; then
+        echo "Skipping this job since it is for: ${version}"
+        exit 0
+    fi
+fi
+
+for py_version in "${python_versions[@]}"; do
+    changed_all_target="all"
+    changed_all_mode="default"
+
+    if [ "${py_version}" == "${python_default}" ]; then
+        # smoketest tests
+        if [ "${CHANGED}" ]; then
+            # with change detection enabled run tests for anything changed
+            # use the smoketest tests for any change that triggers all tests
+            ci="${target}"
+            changed_all_target="shippable/windows/smoketest/"
+            if [ "${target}" == "shippable/windows/group1/" ]; then
+                # only run smoketest tests for group1
+                changed_all_mode="include"
+            else
+                # smoketest tests already covered by group1
+                changed_all_mode="exclude"
+            fi
+        else
+            # without change detection enabled run entire test group
+            ci="${target}"
+        fi
+    else
+        # only run minimal tests for group1
+        if [ "${target}" != "shippable/windows/group1/" ]; then continue; fi
+        # minimal tests for other python versions
+        ci="shippable/windows/minimal/"
+    fi
+
+    # terminate remote instances on the final python version tested
+    if [ "${py_version}" = "${python_versions[-1]}" ]; then
+        terminate="always"
+    else
+        terminate="never"
+    fi
+
+    # shellcheck disable=SC2086
+    ansible-test windows-integration --color -v --retry-on-error "${ci}" ${COVERAGE:+"$COVERAGE"} ${CHANGED:+"$CHANGED"} ${UNSTABLE:+"$UNSTABLE"} \
+        --changed-all-target "${changed_all_target}" --changed-all-mode "${changed_all_mode}" \
+        --controller "docker:default,python=${py_version}" \
+        --target "remote:windows/${version},connection=${connection}+${connection_setting},provider=${provider}" \
+        --remote-terminate "${terminate}" --remote-stage "${stage}"
+done

.azure-pipelines/scripts/combine-coverage.py

@@ -7,8 +7,7 @@ Keep in mind that Azure Pipelines does not enforce unique job display names (onl
 It is up to pipeline authors to avoid name collisions when deviating from the recommended format.
 """
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import re

.azure-pipelines/scripts/publish-codecov.py

@@ -4,6 +4,7 @@ Upload code coverage reports to codecov.io.
 Multiple coverage files from multiple languages are accepted and aggregated after upload.
 Python coverage, as well as PowerShell and Python stubs can all be uploaded.
 """
+from __future__ import annotations
 
 import argparse
 import dataclasses

.azure-pipelines/scripts/time-command.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 """Prepends a relative timestamp to each input line from stdin and writes it to stdout."""
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import sys
 import time

.azure-pipelines/templates/coverage.yml

@@ -6,7 +6,7 @@
 jobs:
   - job: Coverage
     displayName: Code Coverage
-    container: default
+    container: $[ variables.defaultContainer ]
     workspace:
       clean: all
     steps:

.azure-pipelines/templates/test.yml

@@ -11,7 +11,7 @@ jobs:
   - ${{ each job in parameters.jobs }}:
     - job: test_${{ replace(replace(replace(replace(job.test, '/', '_'), '.', '_'), '-', '_'), '@', '_') }}
       displayName: ${{ job.name }}
-      container: default
+      container: $[ variables.defaultContainer ]
       workspace:
         clean: all
       steps:

.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+# .git-blame-ignore-revs
+# Bulk PowerShell sanity fixes
+6def4a3180fe03981ba64c6d8db28fed3bb39c0c
+716631189cb5a3f66b3add98f39e64e98bc17bf7

.github/BOTMETA.yml

@@ -1,151 +0,0 @@
-automerge: false
-collection_redirect: true
-notifications: false
-files:
-  $module_utils/csharp: &id001
-    labels: windows
-    maintainers: $team_windows_core
-    support: core
-  $module_utils/network:
-    labels: networking
-  $module_utils/network/common:
-    maintainers: $team_networking
-    support: network
-  $module_utils/powershell: *id001
-  $modules:
-    ignored: ryansb tomaszkiewicz
-  $modules/lineinfile.py: $team_ansible samdoran
-  $modules/stat.py:
-    ignored: bpennypacker
-  $modules/unarchive.py:
-    ignored: dagwieers
-    labels: m:unarchive
-    maintainers: pileofrogs
-  $modules/add_host.py:
-    ignored: skvidal
-    maintainers: $team_ansible
-  $modules/get_url.py: ptux
-  $modules/uri.py:
-    ignored: romeotheriault
-    maintainers: $team_ansible
-  $modules/pip.py: Lujeni webknjaz
-  $modules//yum.py:
-    ignored: skvidal
-    maintainers: $team_ansible kustodian
-  $modules/user.py: $team_ansible samdoran
-  $modules/pause.py: samdoran
-  $modules/wait_for.py: gregswift
-  $plugins/cliconf/:
-    labels: networking
-  $plugins/connection/psrp.py: *id001
-  $plugins/connection/winrm.py: *id001
-  $plugins/doc_fragments/url_windows.py:
-    labels: windows
-    maintainers: $team_windows_core
-    support: core
-  $plugins/httpapi:
-    labels: networking
-    maintainers: $team_networking
-    support: network
-  $plugins/netconf/:
-    labels: networking
-    maintainers: $team_networking
-    support: network
-  $plugins/shell/powershell.py: *id001
-  $plugins/terminal/:
-    labels: networking
-  $plugins/terminal/__init__.py:
-    support: network
-  .github/BOTMETA.yml:
-    labels: botmeta
-    support: core
-  docs/:
-    maintainers:
-    - acozine
-  docs/docsite/rst/community/:
-    maintainers:
-    - gundalow
-  docs/docsite/rst/dev_guide/:
-    maintainers:
-    - gundalow
-  docs/docsite/rst/network/:
-    labels: networking
-    maintainers:
-    - samccann
-  docs/docsite/rst/user_guide/windows: *id001
-  hacking/report.py:
-    notified: mattclay
-  hacking/shippable/:
-    notified: mattclay
-  lib/ansible/cli/scripts/ansible_connection_cli_stub.py:
-    keywords:
-    - persistent connection
-    labels: networking
-  lib/ansible/config/ansible_builtin_runtime.yml:
-    labels: runtime
-    maintainers: gundalow
-  lib/ansible/executor/powershell: *id001
-  lib/ansible/inventory:
-    keywords:
-    - core inventory
-    - inventory
-    - inventory parsing
-  lib/ansible/playbook/handler.py:
-    keywords:
-    - handlers
-  lib/ansible/playbook/role:
-    keywords:
-    - roles path
-    - roles_path
-    - role
-    - role path
-  lib/ansible/playbook/role/include.py:
-    keywords:
-    - include role
-    - include_role
-    - role include
-  lib/ansible/playbook/role/requirement.py:
-    keywords:
-    - role dependencies
-    - role dep
-    - role dependency
-  lib/ansible/release.py:
-    notified: mattclay nitzmahone
-  lib/ansible/template:
-    keywords:
-    - jinja
-    - jinja2
-  lib/ansible/utils/collection_loader.py:
-    notified: mattclay nitzmahone
-  test/integration/targets/incidental_:
-    notified: mattclay
-  test/lib/:
-    notified: mattclay
-  test/lib/ansible_test/_util/controller/sanity/validate-modules:
-    keywords:
-    - validate-modules
-    notified:
-    - mattclay
-  test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/main.py:
-    notified:
-    - gundalow
-    - sivel
-  test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/schema.py:
-    notified:
-    - gundalow
-    - sivel
-  test/sanity/:
-    notified: mattclay
-  test/sanity/ignore.txt:
-    notified: tremble
-  test/support/:
-    notified: mattclay
-  test/utils/shippable/:
-    notified: mattclay
-macros:
-  module_utils: lib/ansible/module_utils
-  modules: lib/ansible/modules
-  plugins: lib/ansible/plugins
-  team_ansible: []
-  team_networking: Qalthos ganeshrn trishnaguha justjais NilashishC danielmellado rohitthakur2590 GomathiselviS
-  team_windows_core: nitzmahone jborean93

.github/CONTRIBUTING.md

@@ -4,22 +4,75 @@ Hi! Nice to see you here!
 
 ## QUESTIONS ?
 
-Please see the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for information on how to ask questions on the [mailing lists](https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information) and IRC.
+If you have questions about anything related to Ansible, get in touch with us!
+See [Communicating with the Ansible community](https://docs.ansible.com/ansible/devel/community/communication.html) to find out how.
 
-The GitHub issue tracker is not the best place for questions for various reasons, but both IRC and the mailing list are very helpful places for those things, as the community page explains best.
+The [Community Guide](https://docs.ansible.com/ansible/devel/community/index.html) also explains how to contribute
+and interact with the project, including how to submit bug reports and code to Ansible.
+
+Please note that the GitHub issue tracker is not the best place to ask questions for several reasons.
+You'll get more helpful, and quicker, responses in the forum.
 
 ## CONTRIBUTING ?
 
-By contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the license of the project. You can also read the same [CLA](https://docs.ansible.com/ansible/latest/community/contributor_license_agreement.html) on the Ansible docsite.
+By contributing to this project you agree to the [Developer Certificate of Origin (DCO)](#developer-certificate-of-origin-dco).
 
-Please review the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for more information on contributing to Ansible.
+The Ansible project is licensed under the [GPL-3.0](COPYING) or later. Some portions of the code fall under other licenses as noted in individual files.
+
+The Ansible project accepts contributions through GitHub pull requests.
+Please review the [Community Guide](https://docs.ansible.com/ansible/devel/community/index.html) for more information on contributing to Ansible.
 
 ## BUG TO REPORT ?
 
-First and foremost, also check the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
+First and foremost, also check the [Community Guide](https://docs.ansible.com/ansible/devel/community/index.html).
 
-You can report bugs or make enhancement requests at the [Ansible GitHub issue page](http://github.com/ansible/ansible/issues/new/choose) by filling out the issue template that will be presented.
+You can report bugs or make enhancement requests at
+the [Ansible GitHub issue page](http://github.com/ansible/ansible/issues/new/choose) by filling out the issue template that will be presented.
 
-Also please make sure you are testing on the latest released version of Ansible or the development branch; see the [Installation Guide](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) for details.
+Also please make sure you are testing on the latest released version of Ansible or the development branch.
+See the [Installation Guide](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) for details.
 
 Thanks!
+
+## DEVELOPER CERTIFICATE OF ORIGIN (DCO)
+
+This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.
+
+```text
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -19,13 +19,14 @@ body:
       Also test if the latest release and devel branch are affected too.
 
 
-      **Tip:** If you are seeking community support, please consider
-      [starting a mailing list thread or chatting in IRC][ML||IRC].
+      **Tip:** If you are seeking community support, please see
+      [Communicating with the Ansible community][communication] to
+      get in touch and ask questions.
 
 
 
-      [ML||IRC]:
-      https://docs.ansible.com/ansible-core/devel/community/communication.html?utm_medium=github&utm_source=issue_form--bug_report.yml#mailing-list-information
+      [communication]:
+      https://docs.ansible.com/ansible/devel/community/communication.html
 
       [issue search]: ../search?q=is%3Aissue&type=issues
 
@@ -54,7 +55,7 @@ body:
           <em>Why?</em>
         </summary>
 
-        We would do it by ourselves but unfortunatelly, the curent
+        We would do it by ourselves but unfortunately, the current
         edition of GitHub Issue Forms Alpha does not support this yet 🤷
 
 
@@ -87,7 +88,7 @@ body:
 
 
       [collections org]: /ansible-collections
-    placeholder: dnf, apt, yum, pip, user etc.
+    placeholder: dnf, apt, pip, user etc.
   validations:
     required: true
 
@@ -96,7 +97,7 @@ body:
     label: Ansible Version
     description: >-
       Paste verbatim output from `ansible --version` below, under
-      the prompt line. Please don't wrap it with tripple backticks — your
+      the prompt line. Please don't wrap it with triple backticks — your
       whole input will be turned into a code snippet automatically.
     render: console
     value: |
@@ -119,15 +120,17 @@ body:
   attributes:
     label: Configuration
     description: >-
-      Paste verbatim output from `ansible-config dump --only-changed`
-      below, under the prompt line.
-      Please don't wrap it with tripple backticks — your
+      Paste verbatim output from `ansible-config dump --only-changed -t all` below, under the prompt line.
+      (if using a version older than ansible-core 2.12 you should omit the '-t all')
+      Please don't wrap it with triple backticks — your
       whole input will be turned into a code snippet automatically.
     render: console
     value: |
-      $ ansible-config dump --only-changed
+      # if using a version older than ansible-core 2.12 you should omit the '-t all'
+      $ ansible-config dump --only-changed -t all
     placeholder: |
-      $ ansible-config dump --only-changed
+      # if using a version older than ansible-core 2.12 you should omit the '-t all'
+      $ ansible-config dump --only-changed -t all
       DEFAULT_GATHERING(~/src/github/ansible/ansible/ansible.cfg) = smart
       DEFAULT_HOST_LIST(~/src/github/ansible/ansible/ansible.cfg) = ['~/src/github/ansible/ansible/hosts']
       DEFAULT_VAULT_PASSWORD_FILE(~/src/github/ansible/ansible/ansible.cfg) = ~/src/github/ansible/ansible/vault/print-password.sh
@@ -191,7 +194,7 @@ body:
     description: |
       Describe what actually happened. If possible run with extra verbosity (`-vvvv`).
 
-      Paste verbatim command output and don't wrap it with tripple backticks — your
+      Paste verbatim command output and don't wrap it with triple backticks — your
       whole input will be turned into a code snippet automatically.
     render: console
     placeholder: >-
@@ -247,7 +250,7 @@ body:
 
 
       [ansibot help]:
-      /ansible/ansibullbot/blob/master/ISSUE_HELP.md#for-issue-submitters
+      /ansible/ansibotmini#ansibotmini
 
 
 - type: checkboxes
@@ -256,7 +259,7 @@ body:
     description: |
       Read the [Ansible Code of Conduct][CoC] first.
 
-      [CoC]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--bug_report.yml
+      [CoC]: https://docs.ansible.com/ansible/devel/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--bug_report.yml
     options:
     - label: I agree to follow the Ansible Code of Conduct
       required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -2,7 +2,7 @@
 blank_issues_enabled: false  # default: true
 contact_links:
 - name: 🔐 Security bug report 🔥
-  url: https://docs.ansible.com/ansible/latest/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser
+  url: https://docs.ansible.com/ansible/devel/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser
   about: |
     Please learn how to report security vulnerabilities here.
 
@@ -11,12 +11,12 @@ contact_links:
     a prompt response.
 
     For more information, see
-    https://docs.ansible.com/ansible/latest/community/reporting_bugs_and_features.html
+    https://docs.ansible.com/ansible/devel/community/reporting_bugs_and_features.html
 - name: 📝 Ansible Code of Conduct
-  url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser
+  url: https://docs.ansible.com/ansible/devel/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser
   about: ❤ Be nice to other members of the community. ☮ Behave.
-- name: 💬 Talks to the community
-  url: https://docs.ansible.com/ansible/latest/community/communication.html?utm_medium=github&utm_source=issue_template_chooser#mailing-list-information
+- name: 💬 Talk to the community
+  url: https://docs.ansible.com/ansible/devel/community/communication.html?utm_medium=github&utm_source=issue_template_chooser#mailing-list-information
   about: Please ask and answer usage questions here
 - name: ⚡ Working groups
   url: https://github.com/ansible/community/wiki

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -22,18 +22,46 @@ body:
       Also test if the latest release and devel branch are affected too.
 
 
-      **Tip:** If you are seeking community support, please consider
-      [starting a mailing list thread or chatting in IRC][ML||IRC].
+      **Tip:** If you are seeking community support, please see
+      [Communicating with the Ansible community][communication] to
+      get in touch and ask questions.
 
 
-      [ML||IRC]:
-      https://docs.ansible.com/ansible-core/devel/community/communication.html?utm_medium=github&utm_source=issue_form--documentation_report.yml#mailing-list-information
+
+      [communication]:
+      https://docs.ansible.com/ansible/devel/community/communication.html
 
       [issue search]: ../search?q=is%3Aissue&type=issues
 
       [submit a pull request]:
       https://docs.ansible.com/ansible-core/devel/community/documentation_contributions.html
 
+- type: markdown
+  attributes:
+    value: >
+      **Check the repository for your issue.**
+
+      Source files for Ansible community documentation are
+      hosted in different repositories. Please make sure to file an
+      issue in the correct project.
+
+      Documentation for modules/plugins/etc that are officially
+      supported by the Ansible Core Engineering team is available
+      in this (`ansible/ansible`) repository.
+
+      The Installation Guide, Playbook Guide, Developer Guide,
+      and other documentation is available in the
+      [ansible/ansible-documentation] repository.
+      Documentation for other modules/plugins/etc is likely to be
+      available in one of the [Ansible Collections][collections index].
+      If available in the collection documentation, select the
+      **Issue Tracker** button to go directly to the GitHub issues.
+
+
+      [ansible/ansible-documentation]: /ansible/ansible-documentation
+
+      [collections index]:
+      https://docs.ansible.com/ansible/latest/collections/index.html
 
 - type: textarea
   attributes:
@@ -44,7 +72,7 @@ body:
 
 
       **HINT:** Did you know the documentation has a `View on GitHub`
-      link on every page? Feel free to use it to start a pull request
+      link on some pages? Feel free to use it to start a pull request
       right from the GitHub UI!
     placeholder: >-
       I was reading the ansible-core documentation of version X and I'm having
@@ -64,9 +92,6 @@ body:
           <em>Why?</em>
         </summary>
 
-        We would do it by ourselves but unfortunatelly, the curent
-        edition of GitHub Issue Forms Alpha does not support this yet 🤷
-
 
         _We will make it easier in the future, once GitHub
         supports dropdown defaults. Promise!_
@@ -85,19 +110,7 @@ body:
       Write the short name of the rst file, module, plugin, task or
       feature below, *use your best guess if unsure*.
 
-
-      **Tip:** Be advised that the source for some parts of the
-      documentation are hosted outside of this repository. If the page
-      you are reporting describes modules/plugins/etc that are not
-      officially supported by the Ansible Core Engineering team, there
-      is a good chance that it is coming from one of the [Ansible
-      Collections maintained by the community][collections org]. If this
-      is the case, please make sure to file an issue under the
-      appropriate project there instead.
-
-
-      [collections org]: /ansible-collections
-    placeholder: docs/docsite/rst/dev_guide/debugging.rst
+    placeholder: lib/ansible/modules/copy.py
   validations:
     required: true
 
@@ -106,7 +119,7 @@ body:
     label: Ansible Version
     description: >-
       Paste verbatim output from `ansible --version` below, under
-      the prompt line. Please don't wrap it with tripple backticks — your
+      the prompt line. Please don't wrap it with triple backticks — your
       whole input will be turned into a code snippet automatically.
     render: console
     value: |
@@ -129,15 +142,17 @@ body:
   attributes:
     label: Configuration
     description: >-
-      Paste verbatim output from `ansible-config dump --only-changed`
-      below, under the prompt line.
-      Please don't wrap it with tripple backticks — your
+      Paste verbatim output from `ansible-config dump --only-changed -t all` below, under the prompt line.
+      (if using a version older than ansible-core 2.12 you should omit the '-t all')
+      Please don't wrap it with triple backticks — your
       whole input will be turned into a code snippet automatically.
     render: console
     value: |
-      $ ansible-config dump --only-changed
+      # if using a version older than ansible-core 2.12 you should omit the '-t all'
+      $ ansible-config dump --only-changed -t all
     placeholder: |
-      $ ansible-config dump --only-changed
+      # if using a version older than ansible-core 2.12 you should omit the '-t all'
+      $ ansible-config dump --only-changed -t all
       DEFAULT_GATHERING(~/src/github/ansible/ansible/ansible.cfg) = smart
       DEFAULT_HOST_LIST(~/src/github/ansible/ansible/ansible.cfg) = ['~/src/github/ansible/ansible/hosts']
       DEFAULT_VAULT_PASSWORD_FILE(~/src/github/ansible/ansible/ansible.cfg) = ~/src/github/ansible/ansible/vault/print-password.sh
@@ -183,7 +198,7 @@ body:
 
 
       [ansibot help]:
-      /ansible/ansibullbot/blob/master/ISSUE_HELP.md#for-issue-submitters
+      /ansible/ansibotmini#ansibotmini
 
 
 - type: checkboxes
@@ -192,7 +207,7 @@ body:
     description: |
       Read the [Ansible Code of Conduct][CoC] first.
 
-      [CoC]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--documentation_report.yml
+      [CoC]: https://docs.ansible.com/ansible/devel/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--documentation_report.yml
     options:
     - label: I agree to follow the Ansible Code of Conduct
       required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -21,8 +21,7 @@ body:
 
       If unsure, consider filing a [new proposal] instead outlining your
       use-cases, the research and implementation considerations. Then,
-      start a discussion on one of the public [IRC meetings] we have just
-      for this.
+      start a discussion in the [Ansible forum][forum].
 
 
       <details>
@@ -44,21 +43,22 @@ body:
       Also test if the devel branch does not already implement this.
 
 
-      **Tip:** If you are seeking community support, please consider
-      [starting a mailing list thread or chatting in IRC][ML||IRC].
+      **Tip:** If you are seeking community support, please see
+      [Communicating with the Ansible community][communication] to
+      get in touch and ask questions.
 
 
 
       [contribute to collections]:
       https://docs.ansible.com/ansible-core/devel/community/contributing_maintained_collections.html?utm_medium=github&utm_source=issue_form--feature_request.yml
 
-      [IRC meetings]:
-        https://docs.ansible.com/ansible-core/devel/community/communication.html?utm_medium=github&utm_source=issue_form--feature_request.yml#irc-meetings
+      [communication]:
+      https://docs.ansible.com/ansible/devel/community/communication.html
 
       [issue search]: ../search?q=is%3Aissue&type=issues
 
-      [ML||IRC]:
-      https://docs.ansible.com/ansible-core/devel/community/communication.html?utm_medium=github&utm_source=issue_form--feature_request.yml#mailing-list-information
+      [forum help]:
+      https://forum.ansible.com/c/help/6
 
       [new proposal]: ../../proposals/issues/new
 
@@ -109,7 +109,7 @@ body:
           <em>Why?</em>
         </summary>
 
-        We would do it by ourselves but unfortunatelly, the curent
+        We would do it by ourselves but unfortunately, the current
         edition of GitHub Issue Forms Alpha does not support this yet 🤷
 
 
@@ -139,7 +139,7 @@ body:
 
 
       [collections org]: /ansible-collections
-    placeholder: dnf, apt, yum, pip, user etc.
+    placeholder: dnf, apt, pip, user etc.
   validations:
     required: true
 
@@ -176,7 +176,7 @@ body:
 
 
       [ansibot help]:
-      /ansible/ansibullbot/blob/master/ISSUE_HELP.md#for-issue-submitters
+      /ansible/ansibotmini#ansibotmini
 
 
 - type: checkboxes
@@ -185,7 +185,7 @@ body:
     description: |
       Read the [Ansible Code of Conduct][CoC] first.
 
-      [CoC]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--feature_request.yml
+      [CoC]: https://docs.ansible.com/ansible/devel/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--feature_request.yml
     options:
     - label: I agree to follow the Ansible Code of Conduct
       required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,23 +0,0 @@
-##### SUMMARY
-<!--- Describe the change below, including rationale and design decisions -->
-
-<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
-
-##### ISSUE TYPE
-<!--- Pick one below and delete the rest -->
-- Bugfix Pull Request
-- Docs Pull Request
-- Feature Pull Request
-- Test Pull Request
-
-##### COMPONENT NAME
-<!--- Write the short name of the module, plugin, task or feature below -->
-
-##### ADDITIONAL INFORMATION
-<!--- Include additional information to help people understand the change here -->
-<!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
-
-<!--- Paste verbatim command output below, e.g. before and after your change -->
-```paste below
-
-```

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1 @@
+PULL_REQUEST_TEMPLATE/Unclear purpose or motivation.md

.github/PULL_REQUEST_TEMPLATE/Bug fix.md

@@ -0,0 +1,20 @@
+##### SUMMARY
+
+<!--- Describe the change below, including rationale and design decisions -->
+
+<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
+
+##### ISSUE TYPE
+
+- Bugfix Pull Request
+
+##### ADDITIONAL INFORMATION
+
+<!--- Include additional information to help people understand the change here -->
+<!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
+
+<!--- Paste verbatim command output below, e.g. before and after your change -->
+
+```paste below
+
+```

.github/PULL_REQUEST_TEMPLATE/Documentation change.md

@@ -0,0 +1,19 @@
+##### SUMMARY
+
+<!--- Describe the change below, including rationale -->
+
+<!--- HINT: Include "Closes #nnn" if you are fixing an existing issue -->
+
+##### ISSUE TYPE
+
+- Docs Pull Request
+
+##### ADDITIONAL INFORMATION
+
+<!--- Include additional information to help people understand the change here -->
+
+<!--- Paste verbatim command output below, e.g. before and after your change -->
+
+```paste below
+
+```

.github/PULL_REQUEST_TEMPLATE/New feature.md

@@ -0,0 +1,19 @@
+##### SUMMARY
+
+<!--- Describe the change below, including rationale and design decisions -->
+
+<!--- HINT: Include "Resolves #nnn" if you are fixing an existing issue -->
+
+##### ISSUE TYPE
+
+- Feature Pull Request
+
+##### ADDITIONAL INFORMATION
+
+<!--- Include additional information to help people understand the change here -->
+
+<!--- Paste verbatim command output below, e.g. before and after your change -->
+
+```paste below
+
+```

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1 @@
+Unclear purpose or motivation.md

.github/PULL_REQUEST_TEMPLATE/Tests.md

@@ -0,0 +1,20 @@
+##### SUMMARY
+
+<!--- Describe the change below, including rationale and design decisions -->
+
+<!--- HINT: Include "Closes #nnn" if you are fixing an existing issue -->
+
+##### ISSUE TYPE
+
+- Test Pull Request
+
+##### ADDITIONAL INFORMATION
+
+<!--- Include additional information to help people understand the change here -->
+<!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
+
+<!--- Paste verbatim command output below, e.g. before and after your change -->
+
+```paste below
+
+```

.github/PULL_REQUEST_TEMPLATE/Unclear purpose or motivation.md

@@ -0,0 +1,25 @@
+##### SUMMARY
+
+<!--- Describe the change below, including rationale and design decisions -->
+
+<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
+
+##### ISSUE TYPE
+
+<!--- Pick one below and delete the rest -->
+
+- Bugfix Pull Request
+- Docs Pull Request
+- Feature Pull Request
+- Test Pull Request
+
+##### ADDITIONAL INFORMATION
+
+<!--- Include additional information to help people understand the change here -->
+<!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
+
+<!--- Paste verbatim command output below, e.g. before and after your change -->
+
+```paste below
+
+```

.github/RELEASE_NAMES.txt

@@ -0,0 +1,19 @@
+2.18.0  Fool in the Rain
+2.17.0  Gallows Pole
+2.16.0  All My Love
+2.15.0  Ten Years Gone
+2.14.0  C'mon Everybody
+2.13.0  Nobody's Fault but Mine
+2.12.0  Dazed and Confused
+2.11.0  Hey Hey, What Can I Do
+2.10.0  When the Levee Breaks
+2.9.0   Immigrant Song
+2.8.0   How Many More Times
+2.7.0   In the Light
+2.6.0   Heartbreaker
+2.5.0   Kashmir
+2.4.0   Dancing Days
+2.3.0   Ramble On
+2.2.0   The Battle of Evermore
+2.1.0   The Song Remains the Same
+2.0.0   Over the Hills and Far Away

.github/RELEASE_NAMES.yml

@@ -1,14 +0,0 @@
----
-- 2.12.0  Dazed and Confused
-- 2.11.0  Hey Hey, What Can I Do
-- 2.10.0  When the Levee Breaks
-- 2.9.0   Immigrant Song
-- 2.8.0   How Many More Times
-- 2.7.0   In the Light
-- 2.6.0   Heartbreaker
-- 2.5.0   Kashmir
-- 2.4.0   Dancing Days
-- 2.3.0   Ramble On
-- 2.2.0   The Battle of Evermore
-- 2.1.0   The Song Remains the Same
-- 2.0.0   Over the Hills and Far Away

.gitignore

@@ -38,6 +38,7 @@ docs/docsite/rst/cli/ansible-*.rst
 docs/docsite/rst/cli/ansible.rst
 docs/docsite/rst/dev_guide/collections_galaxy_meta.rst
 docs/docsite/rst/dev_guide/testing/sanity/index.rst.new
+docs/docsite/rst/dev_guide/index.rst
 docs/docsite/rst/modules/*.rst
 docs/docsite/rst/collections/*.rst
 !docs/docsite/rst/collections/all_plugins.rst
@@ -52,12 +53,10 @@ docs/docsite/searchindex.js
 docs/docsite/_static/*.gif
 docs/docsite/_static/*.png
 docs/docsite/_static/websupport.js
-# deb building stuff...
-/debian/
-deb-build
 # Vim swap files
 *.swp
 *.swo
+[._]*.un~
 credentials.yml
 # test output
 *.retry
@@ -74,7 +73,16 @@ coverage.xml
 /test/cache/*
 # Development
 /test/develop
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
 venv
+env
 Vagrantfile
 .vagrant
 # Backwards compatibility with `stable-2.9` and earlier branches.
@@ -84,6 +92,8 @@ Vagrantfile
 /lib/ansible_base.egg-info/
 # First used in the `devel` branch during Ansible 2.11 development.
 /lib/ansible_core.egg-info/
+# First used in the `devel` branch during Ansible 2.18 development.
+/ansible_core.egg-info/
 # vendored lib dir
 lib/ansible/_vendor/*
 !lib/ansible/_vendor/__init__.py
@@ -91,8 +101,6 @@ lib/ansible/_vendor/*
 /test/integration/cloud-config-*.*
 !/test/integration/cloud-config-*.*.template
 .python-version
-/hacking/tests/selinux/*.mod
-/hacking/tests/selinux/*.pp
 # Release directory
 packaging/release/ansible_release
 /.cache/

COPYING

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -664,12 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
-
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

MANIFEST.in

@@ -1,40 +1,10 @@
-include README.rst
 include COPYING
-include SYMLINK_CACHE.json
-include requirements.txt
-recursive-include docs *
-include docs/docsite/rst/collections/all_plugins.rst
-exclude docs/docsite/rst_warnings
-exclude docs/docsite/rst/conf.py
-exclude docs/docsite/rst/index.rst
-recursive-exclude docs/docsite/_build *
-recursive-exclude docs/docsite/_extensions *.pyc *.pyo
-include examples/hosts
-include examples/ansible.cfg
-include examples/scripts/ConfigureRemotingForAnsible.ps1
-include examples/scripts/upgrade_to_ps3.ps1
-include lib/ansible/keyword_desc.yml
-recursive-include lib/ansible/executor/powershell *.ps1
-recursive-include lib/ansible/module_utils/csharp *.cs
-recursive-include lib/ansible/module_utils/powershell *.psm1
-recursive-include lib/ansible/modules/windows *.ps1
-recursive-include lib/ansible/galaxy/data *.yml *.j2 README.md ansible.cfg inventory .git_keep
-recursive-include lib/ansible/config *.yml
-recursive-include licenses *.txt
-recursive-include packaging *
-recursive-include test/ansible_test *.py Makefile
-recursive-include test/integration *
-recursive-include test/lib/ansible_test/config *.yml *.template
-recursive-include test/lib/ansible_test/_data *.cfg *.ini *.ps1 *.txt *.yml coveragerc
-recursive-include test/lib/ansible_test/_util *.cfg *.json *.ps1 *.psd1 *.py *.sh *.txt *.yml
-recursive-include test/lib/ansible_test/_util/controller/sanity/validate-modules validate-modules
-recursive-include test/sanity *.json *.py *.txt
-recursive-include test/support *.py *.ps1 *.psm1 *.cs
-exclude test/sanity/code-smell/botmeta.*
-recursive-include test/units *
-include Makefile
-include MANIFEST.in
 include changelogs/CHANGELOG*.rst
 include changelogs/changelog.yaml
-recursive-include hacking/build_library *.py
-include hacking/build-ansible.py
+include licenses/*.txt
+include requirements.txt
+recursive-include packaging *.py *.j2
+recursive-include test/integration *
+recursive-include test/sanity *.in *.json *.py *.txt *.ini
+recursive-include test/support *.py *.ps1 *.psm1 *.cs *.md
+recursive-include test/units *

Makefile

@@ -1,312 +0,0 @@
-# WARN: gmake syntax
-########################################################
-# Makefile for Ansible
-#
-# useful targets:
-#   make clean ---------------- clean up
-#   make webdocs -------------- produce ansible doc at docs/docsite/_build/html
-#   make coredocs ------------- produce core doc at docs/docsite/_build/html
-#   make sdist ---------------- produce a tarball
-#   make deb-src -------------- produce a DEB source
-#   make deb ------------------ produce a DEB
-#   make docs ----------------- rebuild the manpages (results are checked in)
-#   make gettext -------------- produce POT files for docs
-#   make generate-po ---------- generate language specific po file
-#   make needs-translation ---- generate list of file with unstranlated or fuzzy string for a specific language
-#   make tests ---------------- run the tests (see https://docs.ansible.com/ansible/devel/dev_guide/testing_units.html for requirements)
-
-########################################################
-# variable section
-
-NAME = ansible-core
-OS = $(shell uname -s)
-PREFIX ?= '/usr/local'
-SDIST_DIR ?= 'dist'
-
-# This doesn't evaluate until it's called. The -D argument is the
-# directory of the target file ($@), kinda like `dirname`.
-MANPAGES ?= $(patsubst %.rst.in,%,$(wildcard ./docs/man/man1/ansible*.1.rst.in))
-ifneq ($(shell which rst2man 2>/dev/null),)
-ASCII2MAN = rst2man $< $@
-else ifneq ($(shell which rst2man.py 2>/dev/null),)
-ASCII2MAN = rst2man.py $< $@
-else
-ASCII2MAN = @echo "ERROR: rst2man from docutils command is not installed but is required to build $(MANPAGES)" && exit 1
-endif
-
-PYTHON ?= python
-GENERATE_CLI = hacking/build-ansible.py generate-man
-
-# fetch version from project release.py as single source-of-truth
-VERSION := $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --raw || echo error)
-ifeq ($(findstring error,$(VERSION)), error)
-$(error "version_helper failed")
-endif
-
-# Get the branch information from git
-ifneq ($(shell which git),)
-GIT_DATE := $(shell git log -n 1 --format="%ci")
-GIT_HASH := $(shell git log -n 1 --format="%h")
-GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD | sed 's/[-_.\/]//g')
-GITINFO = .$(GIT_HASH).$(GIT_BRANCH)
-else
-GITINFO = ""
-endif
-
-ifeq ($(shell echo $(OS) | egrep -c 'Darwin|FreeBSD|OpenBSD|DragonFly'),1)
-DATE := $(shell date -j -r $(shell git log -n 1 --format="%ct") +%Y%m%d%H%M)
-CPUS ?= $(shell sysctl hw.ncpu|awk '{print $$2}')
-else
-DATE := $(shell date --utc --date="$(GIT_DATE)" +%Y%m%d%H%M)
-CPUS ?= $(shell nproc)
-endif
-
-# Intenationalisation and Localisation
-LANGUAGES ?=
-
-# DEB build parameters
-DEBUILD_BIN ?= debuild
-DEBUILD_OPTS = --source-option="-I"
-DPUT_BIN ?= dput
-DPUT_OPTS ?=
-DEB_DATE := $(shell LC_TIME=C date +"%a, %d %b %Y %T %z")
-DEB_VERSION ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --debversion)
-ifeq ($(OFFICIAL),yes)
-    DEB_RELEASE ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --debrelease)ppa
-    # Sign OFFICIAL builds using 'DEBSIGN_KEYID'
-    # DEBSIGN_KEYID is required when signing
-    ifneq ($(DEBSIGN_KEYID),)
-        DEBUILD_OPTS += -k$(DEBSIGN_KEYID)
-    endif
-else
-    DEB_RELEASE ?= 100.git$(DATE)$(GITINFO)
-    # Do not sign unofficial builds
-    DEBUILD_OPTS += -uc -us
-    DPUT_OPTS += -u
-endif
-DEBUILD = $(DEBUILD_BIN) $(DEBUILD_OPTS)
-DEB_PPA ?= ppa
-# Choose the desired Ubuntu release: lucid precise saucy trusty
-DEB_DIST ?= unstable
-
-# pbuilder parameters
-PBUILDER_ARCH ?= amd64
-PBUILDER_CACHE_DIR = /var/cache/pbuilder
-PBUILDER_BIN ?= pbuilder
-PBUILDER_OPTS ?= --debootstrapopts --variant=buildd --architecture $(PBUILDER_ARCH) --debbuildopts -b
-
-# ansible-test parameters
-ANSIBLE_TEST ?= bin/ansible-test
-TEST_FLAGS ?=
-
-# ansible-test units parameters (make test / make test-py3)
-PYTHON_VERSION ?= $(shell python2 -c 'import sys; print("%s.%s" % sys.version_info[:2])')
-PYTHON3_VERSION ?= $(shell python3 -c 'import sys; print("%s.%s" % sys.version_info[:2])')
-
-# ansible-test integration parameters (make integration)
-IMAGE ?= centos7
-TARGET ?=
-
-########################################################
-
-.PHONY: all
-all: clean python
-
-.PHONY: tests
-tests:
-	$(ANSIBLE_TEST) units -v --python $(PYTHON_VERSION) $(TEST_FLAGS)
-
-.PHONY: tests-py3
-tests-py3:
-	$(ANSIBLE_TEST) units -v --python $(PYTHON3_VERSION) $(TEST_FLAGS)
-
-.PHONY: integration
-integration:
-	$(ANSIBLE_TEST) integration -v --docker $(IMAGE) $(TARGET) $(TEST_FLAGS)
-
-# Regenerate %.1.rst if %.1.rst.in has been modified more
-# recently than %.1.rst.
-%.1.rst: %.1.rst.in
-	sed "s/%VERSION%/$(VERSION)/" $< > $@
-	rm $<
-
-# Regenerate %.1 if %.1.rst or release.py has been modified more
-# recently than %.1. (Implicitly runs the %.1.rst recipe)
-%.1: %.1.rst lib/ansible/release.py
-	$(ASCII2MAN)
-
-.PHONY: clean
-clean:
-	@echo "Cleaning up distutils stuff"
-	rm -rf build
-	rm -rf dist
-	rm -rf lib/ansible*.egg-info/
-	@echo "Cleaning up byte compiled python stuff"
-	find . -type f -regex ".*\.py[co]$$" -delete
-	find . -type d -name "__pycache__" -delete
-	@echo "Cleaning up editor backup files"
-	find . -type f -not -path ./test/units/inventory_test_data/group_vars/noparse/all.yml~ \( -name "*~" -or -name "#*" \) -delete
-	find . -type f \( -name "*.swp" \) -delete
-	@echo "Cleaning up manpage stuff"
-	find ./docs/man -type f -name "*.xml" -delete
-	find ./docs/man -type f -name "*.rst" -delete
-	find ./docs/man/man3 -type f -name "*.3" -delete
-	rm -f ./docs/man/man1/*
-	@echo "Cleaning up output from test runs"
-	rm -rf test/test_data
-	rm -rf logs/
-	rm -rf .cache/
-	rm -f test/units/.coverage*
-	rm -rf test/results/*/*
-	find test/ -type f -name '*.retry' -delete
-	@echo "Cleaning up symlink cache"
-	rm -f SYMLINK_CACHE.json
-	@echo "Cleaning up Debian building stuff"
-	rm -rf debian
-	rm -rf deb-build
-	rm -rf docs/json
-	rm -rf docs/js
-	@echo "Cleaning up docsite"
-	$(MAKE) -C docs/docsite clean
-
-.PHONY: python
-python:
-	$(PYTHON) setup.py build
-
-.PHONY: install
-install:
-	$(PYTHON) setup.py install
-
-install_manpages:
-	gzip -9 $(wildcard ./docs/man/man1/ansible*.1)
-	cp $(wildcard ./docs/man/man1/ansible*.1.gz) $(PREFIX)/man/man1/
-
-.PHONY: sdist_check
-sdist_check:
-	$(PYTHON) -c 'import setuptools, sys; sys.exit(int(not (tuple(map(int, setuptools.__version__.split("."))) > (39, 2, 0))))'
-	$(PYTHON) packaging/sdist/check-link-behavior.py
-
-.PHONY: sdist
-sdist: sdist_check clean docs
-	_ANSIBLE_SDIST_FROM_MAKEFILE=1 $(PYTHON) setup.py sdist --dist-dir=$(SDIST_DIR)
-
-# Official releases generate the changelog as the last commit before the release.
-# Snapshots shouldn't result in new checkins so the changelog is generated as
-# part of creating the tarball.
-.PHONY: snapshot
-snapshot: sdist_check clean docs changelog
-	_ANSIBLE_SDIST_FROM_MAKEFILE=1 $(PYTHON) setup.py sdist --dist-dir=$(SDIST_DIR)
-
-.PHONY: sdist_upload
-sdist_upload: clean docs
-	$(PYTHON) setup.py sdist upload 2>&1 |tee upload.log
-
-.PHONY: changelog
-changelog:
-	PYTHONPATH=./lib antsibull-changelog release -vv --use-ansible-doc && PYTHONPATH=./lib antsibull-changelog generate -vv --use-ansible-doc
-
-.PHONY: debian
-debian: sdist
-	@for DIST in $(DEB_DIST) ; do \
-	    mkdir -p deb-build/$${DIST} ; \
-	    tar -C deb-build/$${DIST} -xvf dist/$(NAME)-$(VERSION).tar.gz ; \
-	    cp -a packaging/debian deb-build/$${DIST}/$(NAME)-$(VERSION)/ ; \
-        sed -ie "s|%VERSION%|$(DEB_VERSION)|g;s|%RELEASE%|$(DEB_RELEASE)|;s|%DIST%|$${DIST}|g;s|%DATE%|$(DEB_DATE)|g" deb-build/$${DIST}/$(NAME)-$(VERSION)/debian/changelog ; \
-	done
-
-.PHONY: deb
-deb: deb-src
-	@for DIST in $(DEB_DIST) ; do \
-	    PBUILDER_OPTS="$(PBUILDER_OPTS) --distribution $${DIST} --basetgz $(PBUILDER_CACHE_DIR)/$${DIST}-$(PBUILDER_ARCH)-base.tgz --buildresult $(CURDIR)/deb-build/$${DIST}" ; \
-	    $(PBUILDER_BIN) create $${PBUILDER_OPTS} --othermirror "deb http://archive.ubuntu.com/ubuntu $${DIST} universe" ; \
-	    $(PBUILDER_BIN) update $${PBUILDER_OPTS} ; \
-	    $(PBUILDER_BIN) build $${PBUILDER_OPTS} deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}.dsc ; \
-	done
-	@echo "#############################################"
-	@echo "Ansible DEB artifacts:"
-	@for DIST in $(DEB_DIST) ; do \
-	    echo deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_amd64.changes ; \
-	done
-	@echo "#############################################"
-
-# Build package outside of pbuilder, with locally installed dependencies.
-# Install BuildRequires as noted in packaging/debian/control.
-.PHONY: local_deb
-local_deb: debian
-	@for DIST in $(DEB_DIST) ; do \
-	    (cd deb-build/$${DIST}/$(NAME)-$(VERSION)/ && $(DEBUILD) -b) ; \
-	done
-	@echo "#############################################"
-	@echo "Ansible DEB artifacts:"
-	@for DIST in $(DEB_DIST) ; do \
-	    echo deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_amd64.changes ; \
-	done
-	@echo "#############################################"
-
-.PHONY: deb-src
-deb-src: debian
-	@for DIST in $(DEB_DIST) ; do \
-	    (cd deb-build/$${DIST}/$(NAME)-$(VERSION)/ && $(DEBUILD) -S) ; \
-	done
-	@echo "#############################################"
-	@echo "Ansible DEB artifacts:"
-	@for DIST in $(DEB_DIST) ; do \
-	    echo deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_source.changes ; \
-	done
-	@echo "#############################################"
-
-.PHONY: deb-upload
-deb-upload: deb
-	@for DIST in $(DEB_DIST) ; do \
-	    $(DPUT_BIN) $(DPUT_OPTS) $(DEB_PPA) deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_amd64.changes ; \
-	done
-
-.PHONY: deb-src-upload
-deb-src-upload: deb-src
-	@for DIST in $(DEB_DIST) ; do \
-	    $(DPUT_BIN) $(DPUT_OPTS) $(DEB_PPA) deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_source.changes ; \
-	done
-
-.PHONY: epub
-epub:
-	(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) epub)
-
-# for arch or gentoo, read instructions in the appropriate 'packaging' subdirectory directory
-.PHONY: webdocs
-webdocs:
-	(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) docs)
-
-.PHONY: coredocs
-coredocs:
-	(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) coredocs)
-
-.PHONY: gettext
-gettext:
-	(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) gettext)
-
-.PHONY: generate-po
-generate-po:
-	(cd docs/docsite/; CPUS=$(CPUS) LANGUAGES=$(LANGUAGES) $(MAKE) generate-po)
-
-.PHONY: needs-translation
-needs-translation:
-	(cd docs/docsite/; CPUS=$(CPUS) LANGUAGES=$(LANGUAGES) $(MAKE) needs-translation)
-
-.PHONY: linkcheckdocs
-linkcheckdocs:
-	(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) linkcheckdocs)
-
-.PHONY: generate_rst
-generate_rst: lib/ansible/cli/*.py
-	mkdir -p ./docs/man/man1/ ; \
-	$(PYTHON) $(GENERATE_CLI) --template-file=docs/templates/man.j2 --output-dir=docs/man/man1/ --output-format man lib/ansible/cli/*.py
-
-
-docs: generate_rst
-	$(MAKE) $(MANPAGES)
-
-.PHONY: alldocs
-alldocs: docs webdocs
-
-version:
-	@echo $(VERSION)

README.md

@@ -0,0 +1,101 @@
+[![PyPI version](https://img.shields.io/pypi/v/ansible-core.svg)](https://pypi.org/project/ansible-core)
+[![Docs badge](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://docs.ansible.com/ansible/latest/)
+[![Chat badge](https://img.shields.io/badge/chat-IRC-brightgreen.svg)](https://docs.ansible.com/ansible/devel/community/communication.html)
+[![Build Status](https://dev.azure.com/ansible/ansible/_apis/build/status/CI?branchName=devel)](https://dev.azure.com/ansible/ansible/_build/latest?definitionId=20&branchName=devel)
+[![Ansible Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg)](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html)
+[![Ansible mailing lists](https://img.shields.io/badge/mailing%20lists-Ansible-orange.svg)](https://docs.ansible.com/ansible/devel/community/communication.html#mailing-list-information)
+[![Repository License](https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg)](COPYING)
+[![Ansible CII Best Practices certification](https://bestpractices.coreinfrastructure.org/projects/2372/badge)](https://bestpractices.coreinfrastructure.org/projects/2372)
+
+# Ansible
+
+Ansible is a radically simple IT automation system. It handles
+configuration management, application deployment, cloud provisioning,
+ad-hoc task execution, network automation, and multi-node orchestration. Ansible makes complex
+changes like zero-downtime rolling updates with load balancers easy. More information on the Ansible [website](https://ansible.com/).
+
+## Design Principles
+
+* Have an extremely simple setup process with a minimal learning curve.
+* Manage machines quickly and in parallel.
+* Avoid custom-agents and additional open ports, be agentless by
+  leveraging the existing SSH daemon.
+* Describe infrastructure in a language that is both machine and human
+  friendly.
+* Focus on security and easy auditability/review/rewriting of content.
+* Manage new remote machines instantly, without bootstrapping any
+  software.
+* Allow module development in any dynamic language, not just Python.
+* Be usable as non-root.
+* Be the easiest IT automation system to use, ever.
+
+## Use Ansible
+
+You can install a released version of Ansible with `pip` or a package manager. See our
+[installation guide](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) for details on installing Ansible
+on a variety of platforms.
+
+Power users and developers can run the `devel` branch, which has the latest
+features and fixes, directly. Although it is reasonably stable, you are more likely to encounter
+breaking changes when running the `devel` branch. We recommend getting involved
+in the Ansible community if you want to run the `devel` branch.
+
+## Communication
+
+Join the Ansible forum to ask questions, get help, and interact with the
+community.
+
+* [Get Help](https://forum.ansible.com/c/help/6): Find help or share your Ansible knowledge to help others.
+  Use tags to filter and subscribe to posts, such as the following:
+  * Posts tagged with [ansible](https://forum.ansible.com/tag/ansible)
+  * Posts tagged with [ansible-core](https://forum.ansible.com/tag/ansible-core)
+  * Posts tagged with [playbook](https://forum.ansible.com/tag/playbook)
+* [Social Spaces](https://forum.ansible.com/c/chat/4): Meet and interact with fellow enthusiasts.
+* [News & Announcements](https://forum.ansible.com/c/news/5): Track project-wide announcements including social events.
+* [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): Get release announcements and important changes.
+
+For more ways to get in touch, see [Communicating with the Ansible community](https://docs.ansible.com/ansible/devel/community/communication.html).
+
+## Contribute to Ansible
+
+* Check out the [Contributor's Guide](./.github/CONTRIBUTING.md).
+* Read [Community Information](https://docs.ansible.com/ansible/devel/community) for all
+  kinds of ways to contribute to and interact with the project,
+  including how to submit bug reports and code to Ansible.
+* Submit a proposed code update through a pull request to the `devel` branch.
+* Talk to us before making larger changes
+  to avoid duplicate efforts. This not only helps everyone
+  know what is going on, but it also helps save time and effort if we decide
+  some changes are needed.
+
+## Coding Guidelines
+
+We document our Coding Guidelines in the [Developer Guide](https://docs.ansible.com/ansible/devel/dev_guide/). We particularly suggest you review:
+
+* [Contributing your module to Ansible](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_checklist.html)
+* [Conventions, tips, and pitfalls](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html)
+
+## Branch Info
+
+* The `devel` branch corresponds to the release actively under development.
+* The `stable-2.X` branches correspond to stable releases.
+* Create a branch based on `devel` and set up a [dev environment](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_general.html#common-environment-setup) if you want to open a PR.
+* See the [Ansible release and maintenance](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) page for information about active branches.
+
+## Roadmap
+
+Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.7, 2.8).
+The [Ansible Roadmap page](https://docs.ansible.com/ansible/devel/roadmap/) details what is planned and how to influence the roadmap.
+
+## Authors
+
+Ansible was created by [Michael DeHaan](https://github.com/mpdehaan)
+and has contributions from over 5000 users (and growing). Thanks everyone!
+
+[Ansible](https://www.ansible.com) is sponsored by [Red Hat, Inc.](https://www.redhat.com)
+
+## License
+
+GNU General Public License v3.0 or later
+
+See [COPYING](COPYING) to see the full text.

README.rst

@@ -1,115 +0,0 @@
-|PyPI version| |Docs badge| |Chat badge| |Build Status| |Code Of Conduct| |Mailing Lists| |License| |CII Best Practices|
-
-*******
-Ansible
-*******
-
-Ansible is a radically simple IT automation system. It handles
-configuration management, application deployment, cloud provisioning,
-ad-hoc task execution, network automation, and multi-node orchestration. Ansible makes complex
-changes like zero-downtime rolling updates with load balancers easy. More information on the Ansible `website <https://ansible.com/>`_.
-
-Design Principles
-=================
-
-*  Have an extremely simple setup process with a minimal learning curve.
-*  Manage machines quickly and in parallel.
-*  Avoid custom-agents and additional open ports, be agentless by
-   leveraging the existing SSH daemon.
-*  Describe infrastructure in a language that is both machine and human
-   friendly.
-*  Focus on security and easy auditability/review/rewriting of content.
-*  Manage new remote machines instantly, without bootstrapping any
-   software.
-*  Allow module development in any dynamic language, not just Python.
-*  Be usable as non-root.
-*  Be the easiest IT automation system to use, ever.
-
-Use Ansible
-===========
-
-You can install a released version of Ansible with ``pip`` or a package manager. See our
-`installation guide <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for details on installing Ansible
-on a variety of platforms.
-
-Power users and developers can run the ``devel`` branch, which has the latest
-features and fixes, directly. Although it is reasonably stable, you are more likely to encounter
-breaking changes when running the ``devel`` branch. We recommend getting involved
-in the Ansible community if you want to run the ``devel`` branch.
-
-Get Involved
-============
-
-*  Read `Community
-   Information <https://docs.ansible.com/ansible/latest/community>`_ for all
-   kinds of ways to contribute to and interact with the project,
-   including mailing list information and how to submit bug reports and
-   code to Ansible.
-*  Join a `Working Group
-   <https://github.com/ansible/community/wiki>`_, an organized community devoted to a specific technology domain or platform.
-*  Submit a proposed code update through a pull request to the ``devel`` branch.
-*  Talk to us before making larger changes
-   to avoid duplicate efforts. This not only helps everyone
-   know what is going on, but it also helps save time and effort if we decide
-   some changes are needed.
-*  For a list of email lists, IRC channels and Working Groups, see the
-   `Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_
-
-Coding Guidelines
-=================
-
-We document our Coding Guidelines in the `Developer Guide <https://docs.ansible.com/ansible/devel/dev_guide/>`_. We particularly suggest you review:
-
-* `Contributing your module to Ansible <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_checklist.html>`_
-* `Conventions, tips, and pitfalls <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html>`_
-
-Branch Info
-===========
-
-*  The ``devel`` branch corresponds to the release actively under development.
-*  The ``stable-2.X`` branches correspond to stable releases.
-*  Create a branch based on ``devel`` and set up a `dev environment <https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#common-environment-setup>`_ if you want to open a PR.
-*  See the `Ansible release and maintenance <https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html>`_ page for information about active branches.
-
-Roadmap
-=======
-
-Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.7, 2.8).
-The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap.
-
-Authors
-=======
-
-Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
-and has contributions from over 5000 users (and growing). Thanks everyone!
-
-`Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc.
-<https://www.redhat.com>`_
-
-License
-=======
-
-GNU General Public License v3.0 or later
-
-See `COPYING <COPYING>`_ to see the full text.
-
-.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible-core.svg
-   :target: https://pypi.org/project/ansible-core
-.. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
-   :target: https://docs.ansible.com/ansible/latest/
-.. |Build Status| image:: https://dev.azure.com/ansible/ansible/_apis/build/status/CI?branchName=devel
-   :target: https://dev.azure.com/ansible/ansible/_build/latest?definitionId=20&branchName=devel
-.. |Chat badge| image:: https://img.shields.io/badge/chat-IRC-brightgreen.svg
-   :target: https://docs.ansible.com/ansible/latest/community/communication.html
-.. |Code Of Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg
-   :target: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
-   :alt: Ansible Code of Conduct
-.. |Mailing Lists| image:: https://img.shields.io/badge/mailing%20lists-Ansible-orange.svg
-   :target: https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information
-   :alt: Ansible mailing lists
-.. |License| image:: https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg
-   :target: COPYING
-   :alt: Repository License
-.. |CII Best Practices| image:: https://bestpractices.coreinfrastructure.org/projects/2372/badge
-   :target: https://bestpractices.coreinfrastructure.org/projects/2372
-   :alt: Ansible CII Best Practices certification

bin/ansible

@@ -1 +1 @@
-../lib/ansible/cli/scripts/ansible_cli_stub.py
+../lib/ansible/cli/adhoc.py

bin/ansible-config

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/config.py

bin/ansible-connection

@@ -1 +0,0 @@
-../lib/ansible/cli/scripts/ansible_connection_cli_stub.py

bin/ansible-console

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/console.py

bin/ansible-doc

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/doc.py

bin/ansible-galaxy

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/galaxy.py

bin/ansible-inventory

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/inventory.py

bin/ansible-playbook

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/playbook.py

bin/ansible-pull

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/pull.py

bin/ansible-vault

@@ -1 +1 @@
-ansible
+../lib/ansible/cli/vault.py

changelogs/CHANGELOG-v2.12.rst

@@ -1,565 +0,0 @@
-====================================================
-ansible-core 2.12 "Dazed and Confused" Release Notes
-====================================================
-
-.. contents:: Topics
-
-
-v2.12.3
-=======
-
-Release Summary
----------------
-
-| Release Date: 2022-02-28
-| `Porting Guide <https://docs.ansible.com/ansible/devel/porting_guides.html>`__
-
-
-Minor Changes
--------------
-
-- The collection loader now reports a Python warning if an attempt is made to install the Ansible collection loader a second time. Previously this condition was reported using an Ansible warning.
-- ansible-test - Installation of ``cryptography`` is no longer version constrained when ``openssl`` 1.1.0 or later is installed.
-- ansible-test - Requirements for the plugin import test are now frozen.
-- ansible-test - The ``pip`` and ``wheel`` packages are removed from all sanity test virtual environments after installation completes to reduce their size. Previously they were only removed from the environments used for the ``import`` sanity test.
-- ansible-test - The hash for all managed sanity test virtual environments has changed. Containers that include ``ansible-test sanity --prime-venvs`` will need to be rebuilt to continue using primed virtual environments.
-- ansible-test - Update ``pip`` used to bootstrap remote FreeBSD instances from version 20.3.4 to 21.3.1.
-- ansible-test - Update the ``alpine`` container to version 3.3.0. This updates the base image from 3.14.2 to 3.15.0, which includes support for installing binary wheels using pip.
-- ansible-test - Update the ``galaxy`` test plugin to get its container from a copy on quay.io.
-- ansible-test - Update the ``openshift`` test plugin to get its container from a copy on quay.io.
-- junit callback - Add support for replacing the directory portion of out-of-tree relative task paths with a placeholder.
-
-Bugfixes
---------
-
-- ansible-test - All virtual environments managed by ansible-test are marked as usable after being bootstrapped, to avoid errors caused by use of incomplete environments. Previously this was only done for sanity tests. Existing environments from previous versions of ansible-test will be recreated on demand due to lacking the new marker.
-- ansible-test - Fix the ``validate-modules`` sanity test to avoid double-loading the collection loader and possibly failing on import of the ``packaging`` module.
-- ansible-test - Import ``yaml.cyaml.CParser`` instead of ``_yaml.CParser`` in the ``yamllint`` sanity test.
-- ansible-test - Replace the directory portion of out-of-tree paths in JUnit files from integration tests with the ``out-of-tree:`` prefix.
-- ansible-test - Sanity tests run with the ``--requirements` option for Python 2.x now install ``virtualenv`` when it is missing or too old. Previously it was only installed if missing. Version 16.7.12 is now installed instead of the latest version on Python 2.7.
-- ansible-test - The ``import`` sanity test no longer reports errors about ``packaging`` being missing when testing collections.
-- ansible-test - Update the ``default`` containers to version 4.2.0.
-- ansible-test - Use https://ci-files.testing.ansible.com/ for instance bootstrapping instead of an S3 endpoint.
-- ansible-test - Use relative paths in JUnit files generated during integration test runs.
-- ansible-test - Virtual environments managed by ansible-test now use consistent versions of ``pip``, ``setuptools`` and ``wheel``. This avoids issues with virtual environments containing outdated or dysfunctional versions of these tools. The initial bootstrapping of ``pip`` is done by ansible-test from an HTTPS endpoint instead of creating the virtual environment with it already present.
-- cleaning facts will now only warn about the variable name and not post the content, which can be undesireable to disclose
-- correctly inherit vars from parent in block (https://github.com/ansible/ansible/issues/75286).
-- gather_facts action now handles the move of base connection plugin types into collections to add/prevent subset argument correctly
-- junit callback - Fix traceback during automatic fact gathering when using relative paths.
-- junit callback - Fix unicode error when handling non-ASCII task paths.
-- ssh connection now uses more correct host source as play_context can ignore loop/delegation variations.
-- task_executor reverts the change to push facts into delegated vars on loop finalization as result managing code already handles this and was duplicating effort to wrong result.
-- template lookup - restore inadvertently deleted default for ``convert_data`` (https://github.com/ansible/ansible/issues/77004)
-- unarchive - Make extraction work when the LANGUAGE environment variable is set to a non-English locale.
-
-v2.12.2
-=======
-
-Release Summary
----------------
-
-| Release Date: 2022-01-31
-| `Porting Guide <https://docs.ansible.com/ansible/devel/porting_guides.html>`__
-
-
-Bugfixes
---------
-
-- Fix ``AttributeError`` when providing password file via ``--connection-password-file`` (https://github.com/ansible/ansible/issues/76530)
-- Fix ``end_play`` to end the current play only (https://github.com/ansible/ansible/issues/76672)
-- Templating - Ensure we catch exceptions when getting ``.filters`` and ``.tests`` attributes on their respective plugins and properly error, instead of aborting which results in no filters being added to the jinja2 environment
-- ``Templar.copy_with_new_env`` - set the ``finalize`` method of the new ``Templar`` object for the new environment (https://github.com/ansible/ansible/issues/76379)
-- ansible-config avoid showing _terms and _input when --only-changed.
-- ansible-galaxy - Fix using the '--ignore-certs' option when there is no server-specific configuration for the Galaxy server.
-- ansible-galaxy collection build - Ignore any existing ``MANIFEST.json`` and ``FILES.json`` in the root directory when building a collection.
-- ansible-test - Fix the ``import`` sanity test to work properly when Ansible's built-in vendoring support is in use.
-- ansible-test - Fix traceback in the ``validate-modules`` sanity test when testing an Ansible module without any callables.
-- ansible-test - Fix traceback when running from an install and delegating execution to a different Python interpreter.
-- ansible-test - Show an error message instead of a traceback when running outside of a supported directory.
-- ansible-test - Update help links to reference ``ansible-core`` instead of ``ansible``.
-- ansible-test - Update unit tests to use the ``--forked`` option instead of the deprecated ``--boxed`` option.
-- async - Improve performance of sending async callback events by never sending the full task through the queue (https://github.com/ansible/ansible/issues/76729)
-- default callback - Ensure we compare FQCN also in lockstep logic, to ensure using the FQCN of a strategy plugin triggers the correct behavior in the default callback plugin. (https://github.com/ansible/ansible/issues/76782)
-- hostname - Do not require SystemdStrategy subclasses for every distro (https://github.com/ansible/ansible/issues/76792)
-- include_vars, properly initialize variable as there is corner case in which it can end up referenced and not defined
-- ssh connection - properly quote controlpersist path given by user to avoid issues with spaces and other characters
-- ssh connection avoid parsing ssh cli debug lines as they can match expected output at high verbosities.
-- sudo become plugin, fix handling of non interactive flags, previous substitution was too naive
-- unarchive - Fix zip archive file listing that caused issues with content postprocessing (https://github.com/ansible/ansible/issues/76067).
-- yum - prevent storing unnecessary cache data by running `yum makecache fast` (https://github.com/ansible/ansible/issues/76336)
-
-v2.12.1
-=======
-
-Release Summary
----------------
-
-| Release Date: 2021-12-06
-| `Porting Guide <https://docs.ansible.com/ansible/devel/porting_guides.html>`__
-
-
-Minor Changes
--------------
-
-- jinja2_native - keep same behavior on Python 3.10.
-
-Bugfixes
---------
-
-- Ansible.ModuleUtils.LinkUtil - Ignore the ``LIB`` environment variable when loading the ``LinkUtil`` code
-- ansible-test - Automatic target requirements installation is now based on the target environment instead of the controller environment.
-- ansible-test - Fix Python real prefix detection when running in a ``venv`` virtual environment.
-- ansible-test - Fix installation and usage of ``pyyaml`` requirement for the ``import`` sanity test for collections.
-- ansible-test - Fix traceback in ``import`` sanity test on Python 2.7 when ``pip`` is not available.
-- ansible-test - Relocate constants to eliminate symlink.
-- ansible-test - Target integration test requirements are now correctly installed for target environments running on the controller.
-- ansible-test - Update the ``default`` containers to version 4.1.1, which includes the updated ``import`` sanity test requirements.
-- ansible-test - Use the legacy collection loader for ``import`` sanity tests on target-only Python versions.
-- set_fact/include_vars correctly handle delegation assignments within loops
-- setup - detect docker container with check for ./dockerenv or ./dockinit (https://github.com/ansible/ansible/pull/74349).
-- validate_argument_spec - Skip suboption validation if the top level option is an invalid type (https://github.com/ansible/ansible/issues/75612).
-
-v2.12.0
-=======
-
-Release Summary
----------------
-
-| Release Date: 2021-11-05
-| `Porting Guide <https://docs.ansible.com/ansible/devel/porting_guides.html>`__
-
-
-Major Changes
--------------
-
-- Python Controller Requirement - Python 3.8 or newer is required for the control node (the machine that runs Ansible) (https://github.com/ansible/ansible/pull/74013)
-- ansible-test - All "cloud" plugins which use containers can now be used with all POSIX and Windows hosts. Previously the plugins did not work with Windows at all, and support for hosts created with the ``--remote`` option was inconsistent.
-- ansible-test - Collections can now specify controller and target specific integration test requirements and constraints. If provided, they take precedence over the previously available requirements and constraints files.
-- ansible-test - Integration tests run with the ``integration`` command can now be executed on two separate hosts instead of always running on the controller. The target host can be one provided by ``ansible-test`` or by the user, as long as it is accessible using SSH.
-- ansible-test - Most container features are now supported under Podman. Previously a symbolic link for ``docker`` pointing to ``podman`` was required.
-- ansible-test - New ``--controller`` and ``--target`` / ``--target-python`` options have been added to allow more control over test environments.
-- ansible-test - Python 3.8 - 3.10 are now required to run ``ansible-test``, thus matching the Ansible controller Python requirements. Older Python versions (2.6 - 2.7 and 3.5 - 3.10) can still be the target for relevant tests.
-- ansible-test - SSH port forwarding and redirection is now used exclusively to make container ports available on non-container hosts. When testing on POSIX systems this requires SSH login as root. Previously SSH port forwarding was combined with firewall rules or other port redirection methods, with some platforms being unsupported.
-- ansible-test - Sanity tests always run in isolated Python virtual environments specific to the requirements of each test. The environments are cached.
-- ansible-test - Sanity tests are now separated into two categories, controller and target. All tests except ``import`` and ``compile`` are controller tests. The controller tests always run using the same Python version used to run ``ansible-test``. The target tests use the Python version(s) specified by the user, or all available Python versions.
-- ansible-test - Sanity tests now use fully pinned requirements that are independent of each other and other test types.
-- ansible-test - Tests run with the ``centos6`` and ``default`` test containers now use a PyPI proxy container to access PyPI when Python 2.6 is used. This allows tests running under Python 2.6 to continue functioning even though PyPI is discontinuing support for non-SNI capable clients.
-- ansible-test - The ``future-import-boilerplate`` and ``metaclass-boilerplate`` sanity tests are limited to remote-only code. Additionally, they are skipped for collections which declare no support for Python 2.x.
-- ansible-test - The ``import`` and ``compile`` sanity tests limit remote-only Python version checks to remote-only code.
-- ansible-test - Unit tests for controller-only code now require Python 3.8 or later.
-- ansible-test - Version neutral sanity tests now require Python 3.8 or later.
-- junit callback - The ``junit_xml`` and ``ordereddict`` Python modules are no longer required to use the ``junit`` callback plugin.
-
-Minor Changes
--------------
-
-- Add ``end_batch`` meta task.
-- Allow connection and become passwords to be set by file/executable script. Also document this was already the case for vault.
-- CLI - Remove ``__requires__`` attribute for ``pkg_resources``
-- Collections can define action_groups in ``meta/runtime.yml``.
-- Introduce a config option to enable/disable emitting warning about Jinja2 version being old for ``jinja2_native``. The option is on by default, only in CI it is off.
-- Make the code structure of ansible-doc's generic snippet feature more maintainable.
-- On RHEL 9, CentOS Stream 9 etc., use /usr/bin/python3 as the default interpreter; /usr/libexec/platform-python is just a backwards-compatibility symbolic link there.
-- PowerShell - Added support for optional module_util imports by scanning for ``-Optional`` at the end of the import declaration
-- Python 2.6 Target Support - Deprecate Python 2.6 for targets, requiring Python 2.7 or newer. ``ansible-core==2.13`` will drop support for Python 2.6. (https://github.com/ansible/ansible/pull/74165)
-- Task - Add a resolved_action attribute for Task objects to get the final resolved plugin.
-- Templar - remove ``_fail_on_lookup_errors`` and ``_fail_on_filter_errors`` instance variables that were never used. (https://github.com/ansible/ansible/pull/73785)
-- The AnsiballZ Python wrapper now changes the working directory to ``~`` or ``/`` if the current one is not accessible. This allows become to drop privileges on macOS when using pipelining.
-- Update test container ansible-core-test-container to version 3.6.0
-- Update test container ansible-core-test-container to version 3.7.0
-- Update test container default-test-container to version 3.6.0
-- Update test container default-test-container to version 3.7.0
-- Update vendored copy of ``six`` to 1.16.0 to eliminate warnings for deprecated python loader methods in Python 3.10+ (https://github.com/ansible/ansible/issues/74659)
-- Update vendored copy of distro to 1.6.0
-- Vendor ``distutils.version`` due to it's deprecation in Python 3.10 and impending removal in Python 3.12 (https://github.com/ansible/ansible/issues/74599)
-- YAML parsing - Create common utils for loading and dumping YAML that prefer the C extensions if available
-- ``include_role`` - Allow use of ``omit`` in the ``from_*`` arguments (https://github.com/ansible/ansible/issues/66349)
-- ``uri``/``get_url`` - Expose ``unredirected_headers`` to modules to allow user control
-- `ansible.plugins.callback.CallbackBase.host_label()` has been factored out as a static method (https://github.com/ansible/ansible/pull/73814).
-- action_groups can include actions from other groups by using the special ``metadata`` dictionary field.
-- add a quick short circuit when checking if a string is a template to improve performance on large strings (https://github.com/ansible/ansible/issues/74336)
-- add host label to retry print statements
-- added new function to module utils to choose best possible locale.
-- adds the ``undef`` keyword to the templating environment. This allows for directly creating Undefined values in templates. It is most useful for providing a hint for variables which must be overridden.
-- ansbile-doc now also shows snippets for inventory and lookup, adding to existing modules.
-- ansible adhoc, clarified the help to some options, also added some comments to code.
-- ansible-cli - remove unnecessary trailing space in ``ansible --version`` (https://github.com/ansible/ansible/issues/74875).
-- ansible-config can now list and dump for specific documentable plugins by specifying them in the command line
-- ansible-config has new 'init' option to create, highly commented, example configurations as ini (ansible.cfg), environment variables (shell) or Ansible variable files (YAML)
-- ansible-config now supports displaying plugin configuration info.
-- ansible-doc - ``version_added`` in ``attributes`` now comes with ``version_added_collection`` (https://github.com/ansible/ansible/pull/74602).
-- ansible-doc - show ``version_added`` for the plugin/module itself in text output, and improve ``version_added`` formatting (https://github.com/ansible/ansible/pull/73602).
-- ansible-doc now supports 'attributes' for plugins as per proposal.
-- ansible-doc pretty cli options output.
-- ansible-doc, improve handling of rstisms, try to make the display more meaningfull for the terminal users.
-- ansible-galaxy - Allow specification of client_id override value for Keycloak Token (https://github.com/ansible/ansible/issues/75593).
-- ansible-galaxy - Allow validate_certs to be configured for individual Galaxy servers (https://github.com/ansible/ansible/issues/75677).
-- ansible-galaxy - Installing a collection from a git repository without specifying a version (or using the version ``HEAD``) will clone the repository using --depth=1.
-- ansible-galaxy - Non-HTTP exceptions from Galaxy servers are now a warning and only fatal if the collection to download|install|verify is not available from any of the servers (https://github.com/ansible/ansible/issues/75443).
-- ansible-test - A new ``base`` test container is available. It is similar to the ``default`` test container, but contains no pre-installed Python packages other than ``pip`` and its dependencies.
-- ansible-test - Add RHEL 8.4 as a remote.
-- ansible-test - Add ``--prime-venvs`` option to create virtual environments without running tests.
-- ansible-test - Add constraint for ``decorator`` for Python versions prior to 3.5.
-- ansible-test - Add support for Windows Server 2022.
-- ansible-test - Add support for an ansible-test configuration file in collections under ``tests/config.yml``.
-- ansible-test - Add support for testing with Python 3.10.
-- ansible-test - Added a ``--prime-containers`` option to support downloading containers without running tests.
-- ansible-test - Adding DigitalOcean cloud support to ansible-test (https://github.com/ansible/ansible/pull/74222).
-- ansible-test - All "cloud" plugins have been refactored for more consistency. For those that use docker containers, management of the containers has been standardized.
-- ansible-test - All "cloud" plugins now use fixed hostnames and ports in tests. Previously some tests used IP addresses and/or randomly assigned ports.
-- ansible-test - Changes made to the ``hosts`` file on test systems are now done using an Ansible playbook for both POSIX and Windows systems. Changes are applied before a test target runs and are reverted after the test target finishes.
-- ansible-test - Clean up code in the cloud plugins.
-- ansible-test - Collections can declare their remote-only code (modules/module_utils and related tests) as controller-only.
-- ansible-test - Collections can limit the Python versions used for testing their remote-only code (modules/module_utils and related tests).
-- ansible-test - Command line help has been updated to hide the ``--remote`` option (and related options) when the user lacks an API key to use the feature.
-- ansible-test - Constraints provided by ``ansible-test`` for Python package installs have been reduced.
-- ansible-test - Default settings are now applied to unknown versions of known ``--remote`` platforms.
-- ansible-test - Distribution specific test containers have been updated to version 3.0.0.
-- ansible-test - Environment checking (``pip``, ``python``, ``~/.ssh/known_hosts``, etc.) is no longer performed when running integration tests.
-- ansible-test - Environment variables exposed by "cloud" plugins are now available to the controller for role based tests. Previously only script based tests had access to the exposed environment variables.
-- ansible-test - Fedora 32 and 33 (``fedora32`` and ``fedora33``) containers have been updated and now allow for ssh in more container environments.
-- ansible-test - Fedora 34 (``fedora34``) container has been added.
-- ansible-test - Installation of ``cryptography`` no longer occurs when it is already installed. This avoids downgrading existing OS packages.
-- ansible-test - Minor code cleanup.
-- ansible-test - More efficient string splitting.
-- ansible-test - Most scripts used internally by ``ansible-test`` no longer have a shebang or the executable bit set.
-- ansible-test - Move code from ``_data`` directory to ``_util`` directory.
-- ansible-test - Relocate change classification code.
-- ansible-test - Remove CI provider support for Shippable, now that the service has been discontinued.
-- ansible-test - Remove check for legacy ``core`` and ``extras`` directories.
-- ansible-test - Remove deprecated container ``fedora32``.
-- ansible-test - Remove deprecated remote platforms ``freebsd/11.4`` and ``rhel/8.3```.
-- ansible-test - Removed the warning filter for ``PyYAML`` in the ``import`` sanity test.
-- ansible-test - Removed unused pip constraints. Collections may need to add their own constraints if they depended on any which were removed.
-- ansible-test - Reorganize code for individual commands.
-- ansible-test - Reorganize integration test implementation by command.
-- ansible-test - Rewrite the ``compile`` sanity test to improve error handling and support Python 3.10.
-- ansible-test - Sanity test warnings relating to Python version support have been improved.
-- ansible-test - Set minimum version constraints for ``pytest``.
-- ansible-test - Split out shell command implementation.
-- ansible-test - The "injector" scripts are now generated at runtime to avoid issues with symlinks and shebangs.
-- ansible-test - The HTTP Tester can now be used without the ``--docker`` or `--remote`` options. It still requires use of the ``docker`` command to run the container.
-- ansible-test - The HTTP Tester has been converted to a "cloud" plugin and can now be requested using the ``cloud/httptester`` alias. The original ``needs/httptester`` alias is still supported for backwards compatibility.
-- ansible-test - The ``--docker-keep-git`` option (used only for testing ansible-core) has been renamed to ``--keep-git``.
-- ansible-test - The ``--python`` option can be used without another delegation option such as the ``--venv`` or ``--docker`` options.
-- ansible-test - The ``ansible-test coverage`` commands ``combine``, ``report``, ``html`` and ``xml`` now support delegation.
-- ansible-test - The ``default`` test container has been updated to version 3.4.0 and now uses Python 3.9 by default instead of Python 3.6.
-- ansible-test - The ``docker run`` option ``--link`` is no longer used to connect test containers. As a result, changes are made to the ``/etc/hosts`` file as needed on all test containers. Previously containers which were used with the ``--link`` option did not require changes to the ``/etc/hosts`` file.
-- ansible-test - The ``import`` sanity test now requires that Ansible modules guard instantiation of ``AnsibleModule`` with a ``if __name__ == '__main__'`` conditional, or equivalent logic.
-- ansible-test - The ``import`` sanity test now requires that non-modules do not instantiate ``AnsibleModule`` on import.
-- ansible-test - The ``validate-modules`` sanity test codes ``ansible-deprecated-module`` and ``collection-deprecated-module`` have been added.
-- ansible-test - The ``validate-modules`` sanity test codes ``last-line-main-call``, ``missing-if-name-main`` and ``missing-main-call`` have been removed.
-- ansible-test - The ``validate-modules`` sanity test no longer enforces the ``missing-if-name-main``, ``last-line-main-call`` or ``missing-main-call`` checks on non-deleted Ansible modules. Modules are still required to instantiate ``AnsibleModule`` when ``__name__ == '__main__'``.
-- ansible-test - Unit tests are now run in separate contexts (``controller``, ``modules``, ``module_utils``), each using separate invocations of ``pytest``.
-- ansible-test - Unit tests other than ``modules`` and ``module_utils`` are now run only on Python versions supported by the controller (Python 3.8+).
-- ansible-test - Update ``typed-ast`` constraint to version 1.4.3 for compatibility with Python 3.10.
-- ansible-test - Update distribution test containers from version 2.0.1 to 2.0.2.
-- ansible-test - Update the Ansible Core and Ansible Collection default test containers to 3.2.0 and 3.2.2 respectively.
-- ansible-test - Update the ``base`` and ``default`` containers from Python 3.10.0rc2 to 3.10.0.
-- ansible-test - Update the ``import`` sanity test to avoid a new warning in Python 3.10.
-- ansible-test - Update the ``runtime-metadata`` sanity test to handle a new warning on Python 3.10.
-- ansible-test - Updated the ``default`` containers to version 4.0.1.
-- ansible-test - Updated the help message for failed tests in the ``azure`` test plugin.
-- ansible-test - Upgrade ``pylint`` to version 2.9.3 and update its dependencies to the latest versions as well.
-- ansible-test - Using an unknown ``--docker`` or ``--remote`` environment now requires specifying a Python version.
-- ansible-test - add freebsd/13.0 as a remote option.
-- ansible-test - aws creates and exposes a new tiny_prefix variable to provide a shorter prefix for the AWS tests.
-- ansible-test - display recent ``ssh`` debug logs after connection failures (https://github.com/ansible/ansible/pull/75374)
-- ansible-test - validate-modules now properly checks ``attributes`` for plugins (https://github.com/ansible/ansible/pull/74602).
-- ansible-test - virtualenv-isolated.sh is no longer provided. Prefer virtualenv.sh in its place.
-- ansible-test validate-modules - enforce that ``_info`` and ``_facts`` modules set ``supports_check_mode=True`` (https://github.com/ansible/ansible/pull/75324).
-- ansible-vault - remove support for ``PyCrypto`` (https://github.com/ansible/ansible/issues/72646)
-- apt - added an ``allow_downgrade`` option to enable safe downgrade of packages without using ``force`` which doesn't verify signatures (https://github.com/ansible/ansible/issues/29451, https://github.com/ansible/ansible/pull/74852).
-- apt, added a 'lock_timeout' to be more resilient when encountering the apt db already locked and handle it w/o haveing to rerun task.
-- async tasks - the use of the task-level ``ANSIBLE_ASYNC_DIR`` variable within ``environment:`` is no longer valid. Use the shell configuration variable ``async_dir`` instead.
-- async_wrapper, better reporting on timeout, slight refactor on reporting itself.
-- basic module_util - Clean up ``selinux`` compat import.
-- blockinfile - Remove unused code for Ansible 1.x.
-- cache base - More efficient string splitting.
-- callback API - implemented ``v2_runner_on_async_ok`` and ``v2_runner_on_async_failed`` callbacks (https://github.com/ansible/ansible/pull/74953).
-- cli scripts - remove trailing blank space in help after newline when outputting.
-- collection - match skip message as per role installation.
-- command - update the user warning message to point out command name (https://github.com/ansible/ansible/pull/74475).
-- config lookup now can handle plugin settings.
-- config, default site for ansible-core is now under /ansbile-core/.
-- connection base - Avoid using deprecated ``@abstractproperty`` decorator.
-- constructed - a new options ``trailing_separator`` and ``default_value`` to deal with key's value empty on keyed group.
-- cron - ``name`` is now a required parameter always
-- cron - ``reboot`` parameter has been dropped in favor of ``special_time: reboot``
-- cron, removed previously deprecated 'reboot' and now requires either 'name' as unique identifier.
-- default callback plugin - displays output for ``v2_runner_on_async_ok`` and ``v2_runner_on_async_failed`` callbacks.
-- deprecate ``_remote_checksum()`` and remove all internal uses (https://github.com/ansible/ansible/pull/74848)
-- dnf - Add ``cacheonly`` option (https://github.com/ansible/ansible/issues/69397).
-- dnf - allow for ``download_only`` to be run without root privileges (https://github.com/ansible/ansible/issues/75530)
-- encrypt - add new parameter ``ident`` to specify version of BCrypt algorithm to be used (https://github.com/ansible/ansible/issues/74571).
-- fact cache - Remove deprecated backwards compatibility shim for the FactCache `update` method to accept multiple arguments.
-- fact cache - Remove the deprecated location for FactCache. Import FactCache from `ansible.vars.fact_cache` instead.
-- facts - add fiber channel facts for HP-UX (https://github.com/ansible/ansible/pull/57406)
-- galaxy - support role artifact download from API response ``download_url`` location (https://github.com/ansible/ansible/issues/73103).
-- get_distribution - ``lib.ansible.module_utils.common.sys_info.get_distribution`` now returns distribution information for all platforms not just Linux (https://github.com/ansible/ansible/issues/17587)
-- get_distribution_version - ``lib.ansible.module_utils.common.sys_info.get_distribution_version`` now returns the version for all platfroms not just Linux (https://github.com/ansible/ansible/issues/17587)
-- git - Add ``accept_newhostkey`` option (https://github.com/ansible/ansible/issues/69846).
-- hostname - add support RedOS (https://github.com/ansible/ansible/issues/74779).
-- import_role - Template tasks_from, vars_from, defaults_from, and handlers_from with --extra-vars (https://github.com/ansible/ansible/issues/69097).
-- include_vars - add ``hash_behaviour`` option (https://github.com/ansible/ansible/pull/72944).
-- ini - added new parameter ``allow_no_value`` to ini lookup plugin (https://github.com/ansible/ansible/issues/50594).
-- ini lookup - add case sensitive option (https://github.com/ansible/ansible/issues/74601)
-- interpreter discovery - allow the default list of ``INTERPRETER_PYTHON_FALLBACK`` to be changed using a variable
-- interpreter discovery - prefer Python 3 over Python 2
-- inventory plugins - Remove the deprecated cache interface. Set top level keys in the inventory plugin's `_cache` attribute (a dictionary) instead.
-- jinja2_native - short-circuit ``ast.literal_eval`` for non-string values
-- module_utils distro - when a 'distro' package/module is in PYTHONPATH but isn't the real 'distro' package/module that we expect, gracefully fall back to our own bundled distro.
-- modules - add Anolis distro in hostname.py. project website https://openanolis.org/
-- move all builtin modules to use the best possible locale function instead of hardcoding 'C'.
-- password - add new parameter ``ident`` to specify version of BCrypt algorithm to be used (https://github.com/ansible/ansible/issues/74571).
-- password - add new parameter ``seed`` in lookup plugin (https://github.com/ansible/ansible/pull/69775).
-- password_hash uses passlib default if option isn't set
-- playbook - Error if a playbook is an empty list instead of just skipping
-- playbook - Error if using ``include`` instead of ``import_playbook``
-- replaced examples/ansible.cfg with instructions on how to generate an up to date copy.
-- service - add description how service module works internally (https://github.com/ansible/ansible/issues/74507).
-- service_facts now handles more states/statuses from systemd and in a more reliable way (failed, not-found, masked).
-- setup - add ``epoch_int`` option to date_time facts (https://github.com/ansible/ansible/pull/73822).
-- ssh - added pkcs11 support by adding the pkcs11_provider option in the ssh connection module. (https://www.github.com/ansible/ansible/pull/32829)
-- ssh connection, can not configure ssh_transfer_method with a variable.
-- ssh connection, ssh_transfer_method is now configurable via variable.
-- subelements lookup - Use generator in instance type check.
-- tempfile - Remove unnecessary conditional for creating a temporary directory.
-- template - Add comment attributes (``comment_start_string`` and ``comment_end_string``)
-- unicode utils - Fix ``__all__`` which was incorrectly declared as a string instead of a tuple.
-- user - Add ``umask`` option (https://github.com/ansible/ansible/issues/40359).
-- user module - Remove unused code.
-- validation testcases for check_* APIs (https://github.com/ansible/ansible/issues/55994).
-- winrm - Allow explicit environment variables to be passed through to the ``kinit`` call for Kerberos authentication
-- yaml dumper - YAML representer for AnsibleUndefined (https://github.com/ansible/ansible/issues/75072).
-- yum - Add ``cacheonly`` option (https://github.com/ansible/ansible/issues/69397).
-
-Breaking Changes / Porting Guide
---------------------------------
-
-- Action, module, and group names in module_defaults must be static values. Their values can still be templates.
-- Fully qualified 'ansible.legacy' plugin names are not included implicitly in action_groups.
-- Unresolvable groups, action plugins, and modules in module_defaults are an error.
-- ansible-test - Automatic installation of requirements for "cloud" test plugins no longer occurs. The affected test plugins are ``aws``, ``azure``, ``cs``, ``hcloud``, ``nios``, ``opennebula``, ``openshift`` and ``vcenter``. Collections should instead use one of the supported integration test requirements files, such as the ``tests/integration/requirements.txt`` file.
-- ansible-test - The HTTP Tester is no longer available with the ``ansible-test shell`` command. Only the ``integration`` and ``windows-integration`` commands provide HTTP Tester.
-- ansible-test - The ``--disable-httptester`` option is no longer available. The HTTP Tester is no longer optional for tests that specify it.
-- ansible-test - The ``--httptester`` option is no longer available. To override the container used for HTTP Tester tests, set the ``ANSIBLE_HTTP_TEST_CONTAINER`` environment variable instead.
-- ansible-test - Unit tests for ``modules`` and ``module_utils`` are now limited to importing only ``ansible.module_utils`` from the ``ansible`` module.
-- conditionals - ``when`` conditionals no longer automatically parse string booleans such as ``"true"`` and ``"false"`` into actual booleans. Any non-empty string is now considered true. The ``CONDITIONAL_BARE_VARS`` configuration variable no longer has any effect.
-- hostname - Drops any remaining support for Python 2.4 by using ``with open()`` to simplify exception handling code which leaked file handles in several spots
-- hostname - On FreeBSD, the string ``temporarystub`` no longer gets written to the hostname file in the get methods (and in check_mode). As a result, the default hostname will now appear as ``''`` (empty string) instead of ``temporarystub`` for consistency with other strategies. This means the ``before`` result will be different.
-- hostname - On OpenRC systems and Solaris, the ``before`` value will now be ``''`` (empty string) if the permanent hostname file does not exist, for consistency with other strategies.
-- intersect, difference, symmetric_difference, union filters - the default behavior is now to be case-sensitive (https://github.com/ansible/ansible/issues/74255)
-- unique filter - the default behavior is now to fail if Jinja2's filter fails and explicit ``case_sensitive=False`` as the Ansible's fallback is case-sensitive (https://github.com/ansible/ansible/pull/74256)
-
-Deprecated Features
--------------------
-
-- ansible-test - The ``--docker-no-pull`` option is deprecated and has no effect.
-- ansible-test - The ``--no-pip-check`` option is deprecated and has no effect.
-- include action is deprecated in favor of include_tasks, import_tasks and import_playbook.
-- module_utils' FileLock is scheduled to be removed, it is not used due to its unreliable nature.
-
-Removed Features (previously deprecated)
-----------------------------------------
-
-- The built-in module_util ``ansible.module_utils.common.removed`` was previously deprecated and has been removed.
-- connections, removed password check stubs that had been moved to become plugins.
-- task, inline parameters being auto coerced into variables has been removed.
-
-Security Fixes
---------------
-
-- Do not include params in exception when a call to ``set_options`` fails. Additionally, block the exception that is returned from being displayed to stdout. (CVE-2021-3620)
-- templating engine fix for not preserving usnafe status when trying to preserve newlines. CVE-2021-3583
-
-Bugfixes
---------
-
-- Add RockyLinux to fact gathering (https://github.com/ansible/ansible/pull/74530).
-- Add unicode support to ``ansible-inventory`` CLI (https://github.com/ansible/ansible/issues/57378)
-- Add yaml representer for VarsWithSources (https://github.com/ansible/ansible/pull/68525).
-- Added page describing terminal plugins to docsite
-- AnsibleModule.set_mode_if_different - don't check file existence when check_mode is activated (https://github.com/ansible/ansible/issues/61185).
-- Apply ``display_failed_stderr`` callback option on loop item results. (https://github.com/ansible/ansible/issues/74864)
-- Binary GnuPG keys downloaded via URLs by the 'ansible.builtin.apt_key' module were corrupted so 'gpg' could not import them (https://github.com/ansible/ansible/issues/74424).
-- Ensure end_play ends play, not batch (https://github.com/ansible/ansible/issues/73971)
-- Ensure we get full path for extra vars into cliargs to avoid realpath issues after initial load.
-- Fix ``keys()`` implementation of ``BaseFileCacheModule`` to strip the prefix from the key and only return keys that share the same prefix as the cache.
-- Fix ``when`` evaluation on Native Jinja and Python 3.10.
-- Fix templating task action with host-specific vars (https://github.com/ansible/ansible/issues/75568)
-- Fully qualified 'ansible.legacy' and 'ansible.builtin' plugin names work in conjunction with module_defaults.
-- Give a warning instead of an error if a handler name contains undefined variables and has no listen topics (https://github.com/ansible/ansible/issues/58841).
-- Improve resilience of ``ansible-galaxy collection`` by increasing the page size to make fewer requests overall and retrying queries with a jittered exponential backoff when rate limiting HTTP codes (520 and 429) occur. (https://github.com/ansible/ansible/issues/74191)
-- Jinja2 globals should be accessible even when importing a template without the context (https://github.com/ansible/ansible/issues/75371)
-- PlayContext - Remove deprecated ``make_become_cmd`` (https://github.com/ansible/ansible/issues/74136)
-- PowerShell - Ignore the ``LIB`` environment variable when compiling C# Ansible code
-- Prevent ``ansible_failed_task`` from further templating (https://github.com/ansible/ansible/issues/74036)
-- Remove 'default' from ssh plugin as we want to rely on default from ssh itself or ssh/config.
-- Replace usage of private dnf.Base() attribute by future dnf API
-- Save unreachable hosts between plays by adding them to the PlayIterator's _play._removed_hosts (https://github.com/ansible/ansible/issues/66945).
-- Solaris - correct version check in svcadm_supports_sync (https://github.com/ansible/ansible/pull/73860).
-- Task depth - Prevent exception when the task depth exceeds Pythons recursion depth (https://github.com/ansible/ansible/issues/73996)
-- Templating - Ensure we catch exceptions when calling ``.filters()`` or ``.tests()`` on their respective plugins and properly error, instead of aborting which results in no filters being added to the jinja2 environment (https://github.com/ansible/ansible/pull/74127)
-- The ``apt_key`` module did not properly handle GnuPG errors (https://github.com/ansible/ansible/issues/74477)
-- The error message about the failure to import a ```gpg`` key by the ``apt_key`` module was incorrect (https://github.com/ansible/ansible/issues/74423).
-- Update network user guide to explain use of cli_parse and validate plugins.
-- Variable Manager - Only check if ``play.hosts`` is a template when the play hasn't been finalized (https://github.com/ansible/ansible/issues/73926)
-- WorkerProcess - Python 3.5 fix for workaround for stdout deadlock in multiprocessing shutdown to avoid process hangs. (https://github.com/ansible/ansible/issues/74149)
-- ``AnsibleModule.run_command`` - Address thread safety issues, concerning mutating the environment, current working directory, and umask. (https://github.com/ansible/ansible/issues/74783)
-- ``failed_when``/``changed_when`` - Catch templating errors to prevent masking of module output (https://github.com/ansible/ansible/issues/37187)
-- ``heuristic_log_sanitize`` - Return the full string if there is no password (https://github.com/ansible/ansible/issues/75542)
-- ``pip`` now uses the ``pip`` Python module installed for the Ansible module's Python interpreter, if available, unless ``executable`` or ``virtualenv`` were specified.
-- advanced_host_list inventory plugin - Fixed variable referenced before assignment when hostname/range could not be parsed.
-- ansiballz - avoid treating path to site_packages as regex; escape it. This prevents a crash when ansible is installed to, or running from, an oddly named directory like ``ansi[ble``
-- ansible-doc - in text output, do not show empty ``version_added_collection`` values (https://github.com/ansible/ansible/pull/74999).
-- ansible-doc can now dump kewyords with --metadata-dump (still just for internal use)
-- ansible-doc, fix output for internal metadata dump option
-- ansible-doc, make inventory plugin selection for snippets generic and not a hardcoded list
-- ansible-galaxy - Fix a bug with build_ignore when installing collections from source (https://github.com/ansible/ansible/issues/75528).
-- ansible-galaxy - Fix handling HTTP exceptions from Galaxy servers. Continue to the next server in the list until the collection is found.
-- ansible-galaxy - Improve error message from dependency resolution when a candidate has inconsistent requirements (https://github.com/ansible/ansible/issues/75139).
-- ansible-inventory - handle an exception while parsing inventory in toml format (https://github.com/ansible/ansible/issues/74404).
-- ansible-playbook, more robust handling of --list-hosts and undefined vars in hosts keyword.
-- ansible-pull - update documentation for ``--directory`` option to clarify path must be absolute.
-- ansible-pull, restore other options to use as repo other than git.
-- ansible-test - Add constraint for ``pyspnego>=0.1.6`` for Python 3.10 - https://github.com/ansible/ansible/pull/74612
-- ansible-test - Avoid publishing the port used by the ``pypi-test-container`` since it is only accessed by other containers. This avoids issues when trying to run tests in parallel on a single host.
-- ansible-test - Failure to download test results from a remote host no longer hide test failures. If a download failure occurs after tests fail, a warning will be issued instead.
-- ansible-test - Fix docker container IP address detection. The ``bridge`` network is no longer assumed to be the default.
-- ansible-test - Fix path to inventory file for ``windows-integration`` and ``network-integration`` commands for collections.
-- ansible-test - Fix traceback when generating coverage reports and no coverage directory exists.
-- ansible-test - Random port selection is no longer handled by ``ansible-test``, avoiding possible port conflicts. Previously ``ansible-test`` would, under some circumstances, use one host's available ports to determine those of another host.
-- ansible-test - Running tests in a single test run with multiple "cloud" plugins no longer results in port conflicts. Previously two or more containers with overlapping ports could not be used in the same test run.
-- ansible-test - Tab completion after options like ``--docker`` which accept an optional argument will no longer provide incorrect completions.
-- ansible-test - The ``--python`` and ``--venv`` options are no longer ignored by some commands, such as ``coverage``.
-- ansible-test - The ``docker inspect`` command is now used to check for existing images instead of the ``docker images`` command. This resolves an issue where a ``docker pull`` would be unnecessarily executed for an image referenced by checksum.
-- ansible-test - Update distribution test containers to version 3.1.0.
-- ansible-test - Use ``--strict`` for ``pytest`` on Python 2.6 since ``--strict-markers`` is not available.
-- ansible-test - Use documented API to retrieve build information from Azure Pipelines.
-- ansible-test - Use pwsh to generate correct coverage line counts for stub files to get a more accurate coverage result
-- ansible-test - Use the correct variable to reference the client's SSH key when generating inventory.
-- ansible-test - add packaging python module to ``ansible-doc`` sanity test requirements.
-- ansible-test - allow the same listening port on all container interfaces
-- ansible-test - ensure the correct unit test target is given when the ``__init__.py`` file is modified inside the connection plugins directory
-- ansible-test - make the ``a/`` and ``b/`` prefixes an optional match since these can be turned off with the ``diff.noprefix`` setting in ``git``
-- ansible-test - restrict ``packaging`` to ``< 21.0`` for Python ``< 3.6`` (https://github.com/ansible/ansible/pull/75186).
-- ansible-test pslint - Fix error when encountering validation results that are highly nested - https://github.com/ansible/ansible/issues/74151
-- ansible-test validate-modules - EXAMPLES will no longer be marked as invalid YAML when it uses Ansible-specific YAML tags (https://github.com/ansible/ansible/pull/74384).
-- ansible-test validate-modules - correctly validate positional parameters to ``AnsibleModules`` (https://github.com/ansible/ansible/pull/75332).
-- ansible.builtin.cron - Keep non-empty crontabs, when removing cron jobs (https://github.com/ansible/ansible/pull/74497).
-- ansible.utils.encrypt now handles missing or unusable 'crypt' library.
-- ansible_test - add constraint for ``MarkupSafe`` (https://github.com/ansible/ansible/pull/74666)
-- apt_key - set --recv argument as last one in apt-key command when using env var HTTP_PROXY (https://github.com/ansible/ansible/issues/74946)
-- arg_spec - remove unused imports
-- async_status, ensure we always get documented returns
-- async_status, resurrected module to deprecate for those that were invoking it directly.
-- basic - skip over module parameters which are used in ``journal.send`` API call (https://github.com/ansible/ansible/issues/71343).
-- become - fix a regression on Solaris where chmod can return 5 which we interpret as auth failure and stop trying become tmpdir permission fallbacks
-- become - work around setfacl not existing on modern Solaris (and possibly failing on some filesystems even when it does exist)
-- callbacks, restore displaying delegation to host as host label.
-- cli defaults for ssh args set to None as '' was bypassing normal default.
-- command - remove unreachable code path when trying to convert the value for ``chdir`` to bytes (https://github.com/ansible/ansible/pull/75036)
-- command module, clarify order of remove/creates checks.
-- command module, correctly handles chdir to symlinks.
-- command module, move to standarized messages in 'msg' vs abusing 'stdout'.
-- command module, now all options work in ad-hoc execution.
-- command module, now always returns what we documented as 'returns always'.
-- config - use ``callbacks_enabled`` instead ``callback_enabled`` in a deprecated message (https://github.com/ansible/ansible/issues/70028).
-- config lookup, can also handle collection plugins now
-- config, ensure 'quoted' lists from ini or env do not take the quotes literally as part of the list item.
-- connection ssh, no ssh_args cli option, so removed doc entry.
-- constants, internal _deprecated function always requires version.
-- correct doc links for become on warnings over world readable settings.
-- correctly use world readable setting since old constant is not 'settable' anymore.
-- dnf - align the return value of the list argument with the ``yum`` module (https://github.com/ansible/ansible/issues/75483)
-- dnf - properly capture transaction error (https://github.com/ansible/ansible/issues/72651)
-- dnf - refactor code to use `dnf whatprovides` API (https://github.com/ansible/ansible/issues/73503).
-- dnf - support non-english environments (https://github.com/ansible/ansible/issues/75021)
-- dnf module - Use all components of a package name to determine if it's installed (https://github.com/ansible/ansible/issues/75311).
-- do not trigger interpreter discovery in the forced_local module path as they should use the ansible playbook python unless otherwise configured.
-- facts - detect homebrew installed at /opt/homebrew/bin/brew
-- facts, service_mgr, handle issues if ps command fails or returns empty.
-- filter plugins - patch new versions of Jinja2 to prevent warnings/errors on renamed filter decorators (https://github.com/ansible/ansible/issues/74667)
-- find - fix a bug where ``size`` argument was ignored for regular files with ``file_type`` of ``any``.
-- find action, correctly convert path to text when warning about skiping.
-- find does not ignore errors from os.walk anymore and issues warnings as expected.
-- gather_facts, improved message on timeout.
-- gather_facts, package, service - fix using module_defaults for the modules in addition to the action plugins. (https://github.com/ansible/ansible/issues/72918)
-- get_bin_path, clarify with quotes what the missing required executable is.
-- get_url - Fixed checksum validation for binary files (leading asterisk) in checksum files (https://github.com/ansible/ansible/pull/74502).
-- getent, fix return data for when there are multiple results for the same key
-- git - Fix git path used when .git file is present (https://github.com/ansible/ansible/issues/75608).
-- host_group_vars vars plugin fixed ini entry, section and key were reversed.
-- hostname - Add Rocky Linux support
-- hostname - No longer modifies system files in get_* methods and therefore when consulted in check_mode (https://github.com/ansible/ansible/issues/66432)
-- include - Remove deprecated ``static`` argument for ``include`` (https://github.com/ansible/ansible/issues/74135)
-- includes - Remove the deprecated ability to specify ``tags`` as ``vars`` on includes (https://github.com/ansible/ansible/issues/74144)
-- ini lookup - better error on mixed/bad parameters
-- ini lookup - handle errors for duplicate keys and missing sections (https://github.com/ansible/ansible/issues/74601)
-- interpreter discovery - Debian 8 and lower will avoid unsupported Python3 version in interpreter discovery
-- interpreter discovery is now handling special (ansible_network_os) cases in less noisy ways.
-- interpreter_discovery - hide warning 'No python interpreters...' when ANSIBLE_PYTHON_INTERPRETER=auto_silent (https://github.com/ansible/ansible/issues/74274).
-- module_common - handle exception when multiple workers try to create the cache directory
-- module_defaults - Fix action defaults for legacy actions/modules (https://github.com/ansible/ansible/issues/75279).
-- module_utils - detect symlinked init systems, even if unable to read /proc/1/comm (https://github.com/ansible/ansible/issues/74866).
-- netconf - catch and handle exception to prevent stack trace when running in FIPS mode
-- network module_utils - fix bug where ``to_bits()`` returned the ``str`` type instead of a useful value.
-- paramiko_ssh - mark connection as connected when ``_connect()`` is called (https://github.com/ansible/ansible/issues/74081)
-- password - Handle passlib wrapped algos bsd_nthash, django_argon2, django_bcrypt, ldap_bcrypt, ldap_bsdi_crypt, ldap_des_crypt, ldap_hex_md5, ldap_hex_sha1, ldap_md5_crypt, ldap_pbkdf2_sha1, ldap_pbkdf2_sha256, ldap_pbkdf2_sha512, ldap_sha1_crypt, ldap_sha256_crypt, ldap_sha512_crypt, roundup_plaintext (https://github.com/ansible/ansible/pull/75527).
-- pause - ensure control characters are always set to an appropriate value (https://github.com/ansible/ansible/issues/73264)
-- pkg_mgr.py - Lower the priority of rpm-ostree detection to avoid false positives on systems not using it as the main package manager (https://github.com/ansible/ansible/issues/74578)
-- play - validate the ``hosts`` entry in a play (https://github.com/ansible/ansible/issues/65386)
-- playbook loaded from collection subdir now does not ignore subdirs.
-- plugin config now allows list type options to have multiple valid choices (#74225).
-- psrp - Always cleanup the last run pipeline if a second pipeline is invoked to avoid violating any resource limits.
-- psrp - Fix error when resetting a connection that was initialised but not connected - (https://github.com/ansible/ansible/issues/74092).
-- psrp - Try to clean up any server-side resources when resetting a connection.
-- recursive_diff - handle condition when parameters are not dict (https://github.com/ansible/ansible/issues/56249).
-- register - Ensure that ``register`` used on ``set_fact`` or ``include_vars`` does not automatically wrap the facts as unsafe. (https://github.com/ansible/ansible/issues/21088)
-- rekey_on_member - handle undefined positional arguments better.
-- remote tmpdir permissions - fix type error in macOS chmod ACL fallback (https://github.com/ansible/ansible/pull/74613).
-- replace - better handling of file operation exceptions (https://github.com/ansible/ansible/pull/74686).
-- roles - allow for role arg specs in new meta file (https://github.com/ansible/ansible/issues/74525).
-- roles - fix unexpected ``AttributeError`` when an empty ``argument_specs.yml`` is present (https://github.com/ansible/ansible/pull/75604).
-- roles - make sure argspec validation task is tagged with ``always`` (https://github.com/ansible/ansible/pull/74994).
-- roles - make sure argspec validation task templates suboptions (https://github.com/ansible/ansible/issues/75070).
-- schema validation now uses dynamic range of versions for valid deprecation entries vs hardcoded out of date list.
-- script inventory plugin - Remove deprecated caching support (https://github.com/ansible/ansible/issues/74143)
-- sequence - fix error message so that unrecognized options to the plugin display correctly as a list and normalize error messages.
-- service - compare version without LooseVersion API (https://github.com/ansible/ansible/issues/74488).
-- set ssh host_key_checking defaults to True, restoring original behaviour (https://github.com/ansible/ansible/issues/75168)
-- setup module should now not truncate hpux interface names.
-- setup module, fix filter to adjust for missing ``ansible_`` prefix on query.
-- setup, while gathering linux hardware facts be more resilient to errors and try to return more info.
-- slurp - Fix error messages for unreadable files and directories(https://github.com/ansible/ansible/issues/67340).
-- slurp - handle error when ``path`` is a directory and not a file (https://github.com/ansible/ansible/pull/74930).
-- slurp - improve the logic in the error handling and remove ``os.stat()`` call (https://github.com/ansible/ansible/pull/75038)
-- ssh connection now correctly handle ssh_transfer_method and scp_if_ssh interactions.
-- ssh connection, fix interaction between trasnfer settings options.
-- ssh connection, use self.host which has the most up2date info instead of pc.remote_addr
-- ssh_connection - rename ``retries`` to ``reconnection_retries`` to avoid conflicts with task vars (https://github.com/ansible/ansible/issues/75142).
-- ssh_connection - set the default for ``reconnection_retries`` back to ``0`` (https://github.com/ansible/ansible/issues/75142).
-- subversion - fix stack trace when getting information about the repository (https://github.com/ansible/ansible/issues/36498)
-- system_service - use a context manager for file handling.
-- task_executor, Actions using AnsibleActionFail/Skip will now propagate 'results' if given
-- task_executor/ssh_connection - use the ``retries`` value from ``ssh_connection`` settings, not the default from the ``Task`` field attributes (https://github.com/ansible/ansible/issues/75142).
-- template - ensure Jinja2 overrides from template header are used (https://github.com/ansible/ansible/issues/75275)
-- unarchive - allow extracting archives that contain files which size exceeds free system memory (https://github.com/ansible/ansible/issues/73985).
-- unarchive - fail when zipinfo binary is not found in executable paths (https://github.com/ansible/ansible/issues/39029).
-- unarchive - move failure for missing binary to ``can_handle_archive()`` rather than ``__init__()``
-- uri - Fix traceback and provide error message when trying to use non-string or mapping for ``form-multipart`` body - https://github.com/ansible/ansible/issues/74276
-- urls - Fix logic in matching ``unredirected_headers`` to perform case insensitive matching
-- validate_argument_spec, correct variable precedence and merge method and add missing examples
-- variable manager, avoid sourcing delegated variables when no inventory hostname is present. This affects scenarios like syntax check and imports.
-- version test - improve error message when an empty version is provided
-- yum - Fixed typo in failure message (https://github.com/ansible/ansible/pull/72964).
-- yum - When upgrading, every architecture of a package is now included in the module results, instead of just one (https://github.com/ansible/ansible/issues/73284).
-- yum - fix ``yumstate`` return value when wildcards are used in the ``list`` argument (https://github.com/ansible/ansible/issues/74557)
-- yum - fix parsing of multiple subsequent empty lines from ``yum check-update`` output (https://github.com/ansible/ansible/issues/70949)
-- yum - yum action plugin changes to support 'use' as an alias of 'use_backend' (https://github.com/ansible/ansible/issues/70774).
-
-Known Issues
-------------
-
-- ansible-test - Tab completion anywhere other than the end of the command with the new composite options will provide incorrect results. See https://github.com/kislyuk/argcomplete/issues/351 for additional details.

changelogs/CHANGELOG-v2.18.rst

@@ -0,0 +1,342 @@
+==================================================
+ansible-core 2.18 "Fool in the Rain" Release Notes
+==================================================
+
+.. contents:: Topics
+
+v2.18.3
+=======
+
+Release Summary
+---------------
+
+| Release Date: 2025-02-24
+| `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__
+
+Minor Changes
+-------------
+
+- ansible-test - Automatically retry HTTP GET/PUT/DELETE requests on exceptions.
+- ansible-test - Use Python's ``urllib`` instead of ``curl`` for HTTP requests.
+
+Bugfixes
+--------
+
+- include_vars - fixed erroneous warning if an unreserved variable name contains a single character that matches a reserved variable. (https://github.com/ansible/ansible/issues/84623)
+- linear strategy - fix executing ``end_role`` meta tasks for each host, instead of handling these as implicit run_once tasks (https://github.com/ansible/ansible/issues/84660).
+
+v2.18.2
+=======
+
+Release Summary
+---------------
+
+| Release Date: 2025-01-27
+| `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__
+
+Bugfixes
+--------
+
+- Ansible will now also warn when reserved keywords are set via a module (set_fact, include_vars, etc).
+- Ansible.Basic - Fix ``required_if`` check when the option value to check is unset or set to null.
+- Use consistent multiprocessing context for action write locks
+- ansible-test - Fix up coverage reporting to properly translate the temporary path of integration test modules to the expected static test module path.
+- ansible-vault will now correctly handle `--prompt`, previously it would issue an error about stdin if no 2nd argument was passed
+- copy action now prevents user from setting internal options.
+- gather_facts action now defaults to `ansible.legacy.setup` if `smart` was set, no network OS was found and no other alias for `setup` was present.
+- gather_facts action will now issues errors and warnings as appropriate if a network OS is detected but no facts modules are defined for it.
+- ssh - Improve the logic for parsing CLIXML data in stderr when working with Windows host. This fixes issues when the raw stderr contains invalid UTF-8 byte sequences and improves embedded CLIXML sequences.
+- ssh - connection options were incorrectly templated during ``reset_connection`` tasks (https://github.com/ansible/ansible/pull/84238).
+
+v2.18.1
+=======
+
+Release Summary
+---------------
+
+| Release Date: 2024-12-02
+| `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__
+
+Minor Changes
+-------------
+
+- ansible-test - When detection of the current container network fails, a warning is now issued and execution continues. This simplifies usage in cases where the current container cannot be inspected, such as when running in GitHub Codespaces.
+
+Security Fixes
+--------------
+
+- Templating will not prefer AnsibleUnsafe when a variable is referenced via hostvars - CVE-2024-11079
+
+Bugfixes
+--------
+
+- Fix returning 'unreachable' for the overall task result. This prevents false positives when a looped task has unignored unreachable items (https://github.com/ansible/ansible/issues/84019).
+- ansible-test - Fix traceback that occurs after an interactive command fails.
+- dnf5 - fix installing a package using ``state=latest`` when a binary of the same name as the package is already installed (https://github.com/ansible/ansible/issues/84259)
+- dnf5 - matching on a binary can be achieved only by specifying a full path (https://github.com/ansible/ansible/issues/84334)
+- runas become - Fix up become logic to still get the SYSTEM token with the most privileges when running as SYSTEM.
+
+v2.18.0
+=======
+
+Release Summary
+---------------
+
+| Release Date: 2024-11-04
+| `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__
+
+Minor Changes
+-------------
+
+- Add ``gid_min``, ``gid_max`` to the group plugin to overwrite the defaults provided by the ``/etc/login.defs`` file (https://github.com/ansible/ansible/pull/81770).
+- Add ``python3.13`` to the default ``INTERPRETER_PYTHON_FALLBACK`` list.
+- Add ``uid_min``, ``uid_max`` to the user plugin to overwrite the defaults provided by the ``/etc/login.defs`` file (https://github.com/ansible/ansible/pull/81770).
+- Add a new meta task ``end_role`` (https://github.com/ansible/ansible/issues/22286)
+- Add a new mount_facts module to support gathering information about mounts that are excluded by default fact gathering.
+- Introducing COLOR_INCLUDED parameter. This can set a specific color for "included" events.
+- Removed the shell ``environment`` config entry as this is already covered by the play/task directives documentation and the value itself is not used in the shell plugins. This should remove any confusion around how people set the environment for a task.
+- Suppress cryptography deprecation warnings for Blowfish and TripleDES when the ``paramiko`` Python module is installed.
+- The minimum supported Python version on targets is now Python 3.8.
+- ``ansible-galaxy collection publish`` - add configuration options for the initial poll interval and the exponential when checking the import status of a collection, since the default is relatively slow.
+- ansible-config has new 'validate' option to find mispelled/forgein configurations in ini file or environment variables.
+- ansible-doc - show examples in role entrypoint argument specs (https://github.com/ansible/ansible/pull/82671).
+- ansible-galaxy - Handle authentication errors and token expiration
+- ansible-test - Add Ubuntu 24.04 remote.
+- ansible-test - Add support for Python 3.13.
+- ansible-test - An ``ansible_core.egg-info`` directory is no longer generated when running tests.
+- ansible-test - Connection options can be set for ansible-test managed remote Windows instances.
+- ansible-test - Default to Python 3.13 in the ``base`` and ``default`` containers.
+- ansible-test - Disable the ``deprecated-`` prefixed ``pylint`` rules as their results vary by Python version.
+- ansible-test - Improve container runtime probe error handling. When unexpected probe output is encountered, an error with more useful debugging information is provided.
+- ansible-test - Improve the error message shown when an unknown ``--remote`` or ``--docker`` option is given.
+- ansible-test - Remove Python 2.7 compatibility imports.
+- ansible-test - Removed the ``vyos/1.1.8`` network remote as it is no longer functional.
+- ansible-test - Replace Alpine 3.19 container and remote with Alpine 3.20.
+- ansible-test - Replace Fedora 39 container and remote with Fedora 40.
+- ansible-test - Replace FreeBSD 14.0 remote with FreeBSD 14.1.
+- ansible-test - Replace RHEL 9.3 remote with RHEL 9.4.
+- ansible-test - Replace Ubuntu 20.04 container with Ubuntu 24.04 container.
+- ansible-test - The ``empty-init`` sanity test no longer applies to ``module_utils`` packages.
+- ansible-test - Update ``ansible-test-utility-container`` to version 3.1.0.
+- ansible-test - Update ``base`` and ``default`` containers to omit Python 3.7.
+- ansible-test - Update ``coverage`` to version 7.6.1.
+- ansible-test - Update ``http-test-container`` to version 3.0.0.
+- ansible-test - Update ``nios-test-container`` to version 5.0.0.
+- ansible-test - Update ``pylint`` sanity test to use version 3.3.1.
+- ansible-test - Update ``pypi-test-container`` to version 3.2.0.
+- ansible-test - Update the ``base`` and ``default`` containers.
+- ansible-test - Updated the frozen requirements for all sanity tests.
+- ansible-test - Upgrade ``pip`` used in ansible-test managed virtual environments from version 24.0 to 24.2.
+- ansible-test - Virtual environments created by ansible-test no longer include the ``wheel`` or ``setuptools`` packages.
+- ansible-test - update HTTP test container to 3.2.0 (https://github.com/ansible/ansible/pull/83469).
+- ansible.log now also shows log severity field
+- distribution.py - Added SL-Micro in Suse OS Family. (https://github.com/ansible/ansible/pull/83541)
+- dnf - minor internal changes in how the errors from the dnf API are handled; rely solely on the exceptions rather than inspecting text embedded in them
+- dnf - remove legacy code for unsupported dnf versions
+- dnf5 - implement ``enable_plugin`` and ``disable_plugin`` options
+- fact gathering - Gather /proc/sysinfo facts on s390 Linux on Z
+- facts - add systemd version and features
+- find - change the datatype of ``elements`` to ``path`` in option ``paths`` (https://github.com/ansible/ansible/pull/83575).
+- ini lookup - add new ``interpolation`` option (https://github.com/ansible/ansible/issues/83755)
+- isidentifier - remove unwanted Python 2 specific code.
+- loop_control - add a break_when option to to break out of a task loop early based on Jinja2 expressions (https://github.com/ansible/ansible/issues/83442).
+- package_facts module now supports using aliases for supported package managers, for example managers=yum or managers=dnf will resolve to using the underlying rpm.
+- plugins, deprecations and warnings concerning configuration are now displayed to the user, technical issue that prevented 'de-duplication' have been resolved.
+- psrp - Remove connection plugin extras vars lookup. This should have no affect on existing users as all options have been documented.
+- remove extraneous selinux import (https://github.com/ansible/ansible/issues/83657).
+- replace random with secrets library.
+- rpm_key - allow validation of gpg key with a subkey fingerprint
+- rpm_key - enable gpg validation that requires presence of multiple fingerprints
+- service_mgr - add support for dinit service manager (https://github.com/ansible/ansible/pull/83489).
+- task timeout now returns timedout key with frame/code that was in execution when the timeout is triggered.
+- timedout test for checking if a task result represents a 'timed out' task.
+- unarchive - Remove Python 2.7 compatibility imports.
+- validate-modules sanity test - detect if names of an option (option name + aliases) do not match between argument spec and documentation (https://github.com/ansible/ansible/issues/83598, https://github.com/ansible/ansible/pull/83599).
+- validate-modules sanity test - reject option/aliases names that are identical up to casing but belong to different options (https://github.com/ansible/ansible/pull/83530).
+- vaulted_file test filter added, to test if the provided path is an 'Ansible vaulted' file
+- yum_repository - add ``excludepkgs`` alias to the ``exclude`` option.
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- Stopped wrapping all commands sent over SSH on a Windows target with a ``powershell.exe`` executable. This results in one less process being started on each command for Windows to improve efficiency, simplify the code, and make ``raw`` an actual raw command run with the default shell configured on the Windows sshd settings. This should have no affect on most tasks except for ``raw`` which now is not guaranteed to always be running in a PowerShell shell and from having the console output codepage set to UTF-8. To avoid this issue either swap to using ``ansible.windows.win_command``, ``ansible.windows.win_shell``, ``ansible.windows.win_powershell`` or manually wrap the raw command with the shell commands needed to set the output console encoding.
+- persistent connection plugins - The ``ANSIBLE_CONNECTION_PATH`` config option no longer has any effect.
+
+Deprecated Features
+-------------------
+
+- Deprecate ``ansible.module_utils.basic.AnsibleModule.safe_eval`` and ``ansible.module_utils.common.safe_eval`` as they are no longer used.
+- persistent connection plugins - The ``ANSIBLE_CONNECTION_PATH`` config option no longer has any effect, and will be removed in a future release.
+- yum_repository - deprecate ``async`` option as it has been removed in RHEL 8 and will be removed in ansible-core 2.22.
+- yum_repository - the following options are deprecated: ``deltarpm_metadata_percentage``, ``gpgcakey``, ``http_caching``, ``keepalive``, ``metadata_expire_filter``, ``mirrorlist_expire``, ``protect``, ``ssl_check_cert_permissions``, ``ui_repoid_vars`` as they have no effect for dnf as an underlying package manager. The options will be removed in ansible-core 2.22.
+
+Removed Features (previously deprecated)
+----------------------------------------
+
+- Play - removed deprecated ``ROLE_CACHE`` property in favor of ``role_cache``.
+- Remove deprecated `VariableManager._get_delegated_vars` method (https://github.com/ansible/ansible/issues/82950)
+- Removed Python 3.10 as a supported version on the controller. Python 3.11 or newer is required.
+- Removed support for setting the ``vars`` keyword to lists of dictionaries. It is now required to be a single dictionary.
+- loader - remove deprecated non-inclusive words (https://github.com/ansible/ansible/issues/82947).
+- paramiko_ssh - removed deprecated ssh_args from the paramiko_ssh connection plugin (https://github.com/ansible/ansible/issues/82939).
+- paramiko_ssh - removed deprecated ssh_common_args from the paramiko_ssh connection plugin (https://github.com/ansible/ansible/issues/82940).
+- paramiko_ssh - removed deprecated ssh_extra_args from the paramiko_ssh connection plugin (https://github.com/ansible/ansible/issues/82941).
+- play_context - remove deprecated PlayContext.verbosity property (https://github.com/ansible/ansible/issues/82945).
+- utils/listify - remove deprecated 'loader' argument from listify_lookup_plugin_terms API (https://github.com/ansible/ansible/issues/82949).
+
+Security Fixes
+--------------
+
+- include_vars action - Ensure that result masking is correctly requested when vault-encrypted files are read. (CVE-2024-8775)
+- task result processing - Ensure that action-sourced result masking (``_ansible_no_log=True``) is preserved. (CVE-2024-8775)
+- user action won't allow ssh-keygen, chown and chmod to run on existing ssh public key file, avoiding traversal on existing symlinks (CVE-2024-9902).
+
+Bugfixes
+--------
+
+- -> runas become - Generate new token for the SYSTEM token to use for become. This should result in the full SYSTEM token being used and problems starting the process that fails with ``The process creation has been blocked``.
+- Add a version ceiling constraint for pypsrp to avoid potential breaking changes in the 1.0.0 release.
+- Add descriptions for ``ansible-galaxy install --help` and ``ansible-galaxy role|collection install --help``.
+- Avoid truncating floats when casting into int, as it can lead to truncation and unexpected results. 0.99999 will be 0, not 1.
+- COLOR_SKIP will not alter "included" events color display anymore.
+- Callbacks now correctly get the resolved connection plugin name as the connection used.
+- Darwin - add unit tests for Darwin hardware fact gathering.
+- Errors now preserve stacked error messages even when YAML is involved.
+- Fix ``SemanticVersion.parse()`` to store the version string so that ``__repr__`` reports it instead of ``None`` (https://github.com/ansible/ansible/pull/83831).
+- Fix a traceback when an environment variable contains certain special characters (https://github.com/ansible/ansible/issues/83498)
+- Fix an issue when setting a plugin name from an unsafe source resulted in ``ValueError: unmarshallable object`` (https://github.com/ansible/ansible/issues/82708)
+- Fix an issue where registered variable was not available for templating in ``loop_control.label`` on skipped looped tasks (https://github.com/ansible/ansible/issues/83619)
+- Fix disabling SSL verification when installing collections and roles from git repositories. If ``--ignore-certs`` isn't provided, the value for the ``GALAXY_IGNORE_CERTS`` configuration option will be used (https://github.com/ansible/ansible/issues/83326).
+- Fix for ``meta`` tasks breaking host/fork affinity with ``host_pinned`` strategy (https://github.com/ansible/ansible/issues/83294)
+- Fix handlers not being executed in lockstep using the linear strategy in some cases (https://github.com/ansible/ansible/issues/82307)
+- Fix rapid memory usage growth when notifying handlers using the ``listen`` keyword (https://github.com/ansible/ansible/issues/83392)
+- Fix the task attribute ``resolved_action`` to show the FQCN instead of ``None`` when ``action`` or ``local_action`` is used in the playbook.
+- Fix using ``module_defaults`` with ``local_action``/``action`` (https://github.com/ansible/ansible/issues/81905).
+- Fix using the current task's directory for looking up relative paths within roles (https://github.com/ansible/ansible/issues/82695).
+- Improve performance on large inventories by reducing the number of implicit meta tasks.
+- Remove deprecated config options DEFAULT_FACT_PATH, DEFAULT_GATHER_SUBSET, and DEFAULT_GATHER_TIMEOUT in favor of setting ``fact_path``, ``gather_subset`` and ``gather_timeout`` as ``module_defaults`` for ``ansible.builtin.setup``.
+  These will apply to both the ``gather_facts`` play keyword, and any ``ansible.builtin.setup`` tasks.
+  To configure these options only for the ``gather_facts`` keyword, set these options as play keywords also.
+- Set LANGUAGE environment variable is set to a non-English locale (https://github.com/ansible/ansible/issues/83608).
+- Use the requested error message in the ansible.module_utils.facts.timeout timeout function instead of hardcoding one.
+- ``ansible-galaxy install --help`` - Fix the usage text and document that the requirements file passed to ``-r`` can include collections and roles.
+- ``ansible-galaxy role install`` - update the default timeout to download archive URLs from 20 seconds to 60 (https://github.com/ansible/ansible/issues/83521).
+- ``end_host`` - fix incorrect return code when executing ``end_host`` in the ``rescue`` section (https://github.com/ansible/ansible/issues/83447)
+- ``package``/``dnf`` action plugins - provide the reason behind the failure to gather the ``ansible_pkg_mgr`` fact to identify the package backend
+- addressed issue of trailing text been ignored, non-ASCII characters are parsed, enhance white space handling and fixed overly permissive issue of human_to_bytes filter(https://github.com/ansible/ansible/issues/82075)
+- ansible-config will now properly template defaults before dumping them.
+- ansible-doc - fixed "inicates" typo in output
+- ansible-doc - format top-level descriptions with multiple paragraphs as multiple paragraphs, instead of concatenating them (https://github.com/ansible/ansible/pull/83155).
+- ansible-doc - handle no_fail condition for role.
+- ansible-doc - make colors configurable.
+- ansible-galaxy collection install - remove old installation info when installing collections (https://github.com/ansible/ansible/issues/83182).
+- ansible-galaxy role install - fix symlinks (https://github.com/ansible/ansible/issues/82702, https://github.com/ansible/ansible/issues/81965).
+- ansible-test - Enable the ``sys.unraisablehook`` work-around for the ``pylint`` sanity test on Python 3.11. Previously the work-around was only enabled for Python 3.12 and later. However, the same issue has been discovered on Python 3.11.
+- ansible-test - The ``pylint`` sanity test now includes the controller/target context of files when grouping them. This allows the ``--py-version`` option to be passed to ``pylint`` to indicate the minimum supported Python version for each test context, preventing ``pylint`` from defaulting to the Python version used to invoke the test.
+- ansible-test action-plugin-docs - Fix to check for sidecar documentation for action plugins
+- ansible_managed restored it's 'templatability' by ensuring the possible injection routes are cut off earlier in the process.
+- apt - report changed=True when some packages are being removed (https://github.com/ansible/ansible/issues/46314).
+- apt_* - add more info messages raised while updating apt cache (https://github.com/ansible/ansible/issues/77941).
+- assemble - update argument_spec with 'decrypt' option which is required by action plugin (https://github.com/ansible/ansible/issues/80840).
+- atomic_move - fix using the setgid bit on the parent directory when creating files (https://github.com/ansible/ansible/issues/46742, https://github.com/ansible/ansible/issues/67177).
+- config, restored the ability to set module compression via a variable
+- connection plugins using the 'extras' option feature would need variables to match the plugin's loaded name, sometimes requiring fqcn, which is not the same as the documented/declared/expected variables. Now we fall back to the 'basename' of the fqcn, but plugin authors can still set the expected value directly.
+- copy - mtime/atime not updated. Fix now update mtime/atime(https://github.com/ansible/ansible/issues/83013)
+- csvfile lookup - give an error when no search term is provided using modern config syntax (https://github.com/ansible/ansible/issues/83689).
+- debconf - fix normalization of value representation for boolean vtypes in new packages (https://github.com/ansible/ansible/issues/83594)
+- debconf - set empty password values (https://github.com/ansible/ansible/issues/83214).
+- delay keyword is now a float, matching the underlying 'time' API and user expectations.
+- display - warn user about empty log filepath (https://github.com/ansible/ansible/issues/79959).
+- display now does a better job of mapping warnings/errors to the proper log severity when using ansible.log. We still use color as a fallback mapping (now prioritiezed by severity) but mostly rely on it beind directly set by warnning/errors calls.
+- distro package - update the distro package version from 1.8.0 to 1.9.0  (https://github.com/ansible/ansible/issues/82935)
+- dnf - Ensure that we are handling DownloadError properly in the dnf module
+- dnf - Substitute variables in DNF cache path (https://github.com/ansible/ansible/pull/80094).
+- dnf - fix an issue where two packages of the same ``evr`` but different arch failed to install (https://github.com/ansible/ansible/issues/83406)
+- dnf - honor installroot for ``cachedir``, ``logdir`` and ``persistdir``
+- dnf - perform variable substitutions in ``logdir`` and ``persistdir``
+- dnf, dnf5 - fix for installing a set of packages by specifying them using a wildcard character (https://github.com/ansible/ansible/issues/83373)
+- dnf5 - fix traceback when ``enable_plugins``/``disable_plugins`` is used on ``python3-libdnf5`` versions that do not support this functionality
+- dnf5 - re-introduce the ``state: installed`` alias to ``state: present`` (https://github.com/ansible/ansible/issues/83960)
+- dnf5 - replace removed API calls
+- ensure we have logger before we log when we have increased verbosity.
+- facts - `support_discard` now returns `0` if either `discard_granularity` or `discard_max_hw_bytes` is zero; otherwise it returns the value of `discard_granularity`, as before (https://github.com/ansible/ansible/pull/83480).
+- facts - add a generic detection for VMware in product name.
+- facts - add facts about x86_64 flags to detect microarchitecture (https://github.com/ansible/ansible/issues/83331).
+- facts - skip if distribution file path is directory, instead of raising error (https://github.com/ansible/ansible/issues/84006).
+- fetch - add error message when using ``dest`` with a trailing slash that becomes a local directory - https://github.com/ansible/ansible/issues/82878
+- file - retrieve the link's full path when hard linking a soft link with follow (https://github.com/ansible/ansible/issues/33911).
+- fixed the issue of creating user directory using tilde(~) always reported "changed".(https://github.com/ansible/ansible/issues/82490)
+- fixed unit test test_borken_cowsay to address mock not been properly applied when existing unix system already have cowsay installed.
+- freebsd - refactor dmidecode fact gathering code for simplicity.
+- freebsd - update disk and slices regex for fact gathering (https://github.com/ansible/ansible/pull/82081).
+- get_url - Verify checksum using tmpsrc, not dest (https://github.com/ansible/ansible/pull/64092)
+- git - check if git version is available or not before using it for comparison (https://github.com/ansible/ansible/issues/72321).
+- include_tasks - Display location when attempting to load a task list where ``include_*`` did not specify any value - https://github.com/ansible/ansible/issues/83874
+- known_hosts - the returned module invocation now accurately reflects the module arguments.
+- linear strategy now provides a properly templated task name to the v2_runner_on_started callback event.
+- linear strategy: fix handlers included via ``include_tasks`` handler to be executed in lockstep (https://github.com/ansible/ansible/issues/83019)
+- linux - remove extraneous get_bin_path API call.
+- local - handle error while parsing values in ini files (https://github.com/ansible/ansible/issues/82717).
+- lookup - Fixed examples of csv lookup plugin (https://github.com/ansible/ansible/issues/83031).
+- module_defaults - do not display action/module deprecation warnings when using an action_group that contains a deprecated plugin (https://github.com/ansible/ansible/issues/83490).
+- module_utils atomic_move (used by most file based modules), now correctly handles permission copy and setting mtime correctly across all paths
+- package_facts - apk fix when cache is empty (https://github.com/ansible/ansible/issues/83126).
+- package_facts - no longer fails silently when the selected package manager is unable to list packages.
+- package_facts - returns the correct warning when package listing fails.
+- persistent connection plugins - The correct Ansible persistent connection helper is now always used. Previously, the wrong script could be used, depending on the value of the ``PATH`` environment variable. As a result, users were sometimes required to set ``ANSIBLE_CONNECTION_PATH`` to use the correct script.
+- powershell - Implement more robust deletion mechanism for C# code compilation temporary files. This should avoid scenarios where the underlying temporary directory may be temporarily locked by antivirus tools or other IO problems. A failure to delete one of these temporary directories will result in a warning rather than an outright failure.
+- powershell - Improve CLIXML decoding to decode all control characters and unicode characters that are encoded as surrogate pairs.
+- psrp - Fix bug when attempting to fetch a file path that contains special glob characters like ``[]``
+- replace - Updated before/after example (https://github.com/ansible/ansible/issues/83390).
+- runtime-metadata sanity test - do not crash on deprecations if ``galaxy.yml`` contains an empty ``version`` field (https://github.com/ansible/ansible/pull/83831).
+- service - fix order of CLI arguments on FreeBSD (https://github.com/ansible/ansible/pull/81377).
+- service_facts - don't crash if OpenBSD rcctl variable contains '=' character (https://github.com/ansible/ansible/issues/83457)
+- service_facts will now detect failed services more accurately across systemd implementations.
+- setup module (fact gathering), added fallbcak code path to handle mount fact gathering in linux when threading is not available
+- setup/gather_facts will skip missing ``sysctl`` instead of being a fatal error (https://github.com/ansible/ansible/pull/81297).
+- shell plugin - properly quote all needed components of shell commands (https://github.com/ansible/ansible/issues/82535)
+- ssh - Fix bug when attempting to fetch a file path with characters that should be quoted when using the ``piped`` transfer method
+- support the countme option when using yum_repository
+- systemd - extend systemctl is-enabled check to handle "enabled-runtime" (https://github.com/ansible/ansible/pull/77754).
+- systemd facts - handle AttributeError raised while gathering facts on non-systemd hosts.
+- systemd_service - handle mask operation failure (https://github.com/ansible/ansible/issues/81649).
+- templating hostvars under native jinja will not cause serialization errors anymore.
+- the raw arguments error now just displays the short names of modules instead of every possible variation
+- unarchive - Better handling of files with an invalid timestamp in zip file (https://github.com/ansible/ansible/issues/81092).
+- unarchive - trigger change when size and content differ when other properties are unchanged (https://github.com/ansible/ansible/pull/83454).
+- unsafe data - Address an incompatibility when iterating or getting a single index from ``AnsibleUnsafeBytes``
+- unsafe data - Address an incompatibility with ``AnsibleUnsafeText`` and ``AnsibleUnsafeBytes`` when pickling with ``protocol=0``
+- unsafe data - Enable directly using ``AnsibleUnsafeText`` with Python ``pathlib`` (https://github.com/ansible/ansible/issues/82414)
+- uri - deprecate 'yes' and 'no' value for 'follow_redirects' parameter.
+- user action will now require O(force) to overwrite the public part of an ssh key when generating ssh keys, as was already the case for the private part.
+- user module now avoids changing ownership of files symlinked in provided home dir skeleton
+- vault - handle vault password file value when it is directory (https://github.com/ansible/ansible/issues/42960).
+- vault.is_encrypted_file is now optimized to be called in runtime and not for being called in tests
+- vault_encrypted test documentation, name and examples have been fixed, other parts were clarified
+- winrm - Add retry after exceeding commands per user quota that can occur in loops and action plugins running multiple commands.
+
+Known Issues
+------------
+
+- ansible-test - When using ansible-test containers with Podman on a Ubuntu 24.04 host, ansible-test must be run as a non-root user to avoid permission issues caused by AppArmor.
+- ansible-test - When using the Fedora 40 container with Podman on a Ubuntu 24.04 host, the ``unix-chkpwd`` AppArmor profile must be disabled on the host to allow SSH connections to the container.
+
+New Plugins
+-----------
+
+Test
+~~~~
+
+- timedout - did the task time out
+- vaulted_file - Is this file an encrypted vault
+
+New Modules
+-----------
+
+Lib
+~~~
+
+ansible.modules
+^^^^^^^^^^^^^^^
+
+- mount_facts - Retrieve mount information.

changelogs/CHANGELOG.rst

@@ -1,6 +0,0 @@
-Placeholder changelog
-=====================
-
-This file is a placeholder; a version-specific ``CHANGELOG-vX.Y.rst`` will be generated during releases from fragments
-under changelogs/fragments. On release branches once a release has been created, consult the branch's version-specific
-file for changes that have occurred in that branch.

changelogs/README.md

@@ -0,0 +1,8 @@
+Changelogs
+==========
+
+As part of the release process a version-specific `CHANGELOG-vX.Y.rst` will be generated from fragments in
+the `fragments` directory.
+
+On release branches once a release has been created, consult the branch's version-specific file for changes that have
+occurred in that branch. The `devel` branch does not have a generated changelog, only changelog fragments.

changelogs/fragments/17587-get-distribution-more-distros.yml

@@ -1,7 +0,0 @@
-minor_changes:
-  - >
-    get_distribution - ``lib.ansible.module_utils.common.sys_info.get_distribution`` now returns
-    distribution information for all platforms not just Linux (https://github.com/ansible/ansible/issues/17587)
-  - >
-    get_distribution_version - ``lib.ansible.module_utils.common.sys_info.get_distribution_version`` now
-    returns the version for all platfroms not just Linux (https://github.com/ansible/ansible/issues/17587)

changelogs/fragments/2.18.0_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2024-11-04
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.0b1_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2024-09-24
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.0rc1_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2024-10-14
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.0rc2_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2024-10-29
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.1_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2024-12-02
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.1rc1_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2024-11-25
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.2_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2025-01-27
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.2rc1_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2025-01-20
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.3_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2025-02-24
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/2.18.3rc1_summary.yaml

@@ -0,0 +1,3 @@
+release_summary: |
+   | Release Date: 2025-02-17
+   | `Porting Guide <https://docs.ansible.com/ansible-core/2.18/porting_guides/porting_guide_core_2.18.html>`__

changelogs/fragments/21088-no-auto-unsafe-set-fact-include-vars-with-register.yml

@@ -1,4 +0,0 @@
-bugfixes:
-- register - Ensure that ``register`` used on ``set_fact`` or ``include_vars``
-  does not automatically wrap the facts as unsafe.
-  (https://github.com/ansible/ansible/issues/21088)

changelogs/fragments/212-py26-deprecation.yml

@@ -1,4 +0,0 @@
-minor_changes:
-- Python 2.6 Target Support - Deprecate Python 2.6 for targets, requiring Python 2.7 or newer.
-  ``ansible-core==2.13`` will drop support for Python 2.6.
-  (https://github.com/ansible/ansible/pull/74165)

changelogs/fragments/29457-deprecate-remote_checksum.yml

@@ -1,2 +0,0 @@
-minor_changes:
-  - deprecate ``_remote_checksum()`` and remove all internal uses (https://github.com/ansible/ansible/pull/74848)

changelogs/fragments/32829-ssh-connection-module-add-pkcs11-support.yml

@@ -1,3 +0,0 @@
-minor_changes:
-  - ssh - added pkcs11 support by adding the pkcs11_provider option in the
-    ssh connection module. (https://www.github.com/ansible/ansible/pull/32829)

changelogs/fragments/36498-subversion-fix-info-parsing.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - subversion - fix stack trace when getting information about the repository (https://github.com/ansible/ansible/issues/36498)

changelogs/fragments/37187-catch-cond-tmpl-errors.yml

@@ -1,4 +0,0 @@
-bugfixes:
-- >-
-  ``failed_when``/``changed_when`` - Catch templating errors to prevent masking of module output
-  (https://github.com/ansible/ansible/issues/37187)

changelogs/fragments/39029_unarchive.yml

@@ -1,2 +0,0 @@
-bugfixes:
-- unarchive - fail when zipinfo binary is not found in executable paths (https://github.com/ansible/ansible/issues/39029).

changelogs/fragments/42960_vault_password.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+- vault - handle vault password file value when it is directory (https://github.com/ansible/ansible/issues/42960).

changelogs/fragments/46314.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - apt - report changed=True when some packages are being removed (https://github.com/ansible/ansible/issues/46314).

changelogs/fragments/46742-atomic_move-fix-setgid.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - atomic_move - fix using the setgid bit on the parent directory when creating files (https://github.com/ansible/ansible/issues/46742, https://github.com/ansible/ansible/issues/67177).

changelogs/fragments/50594_ini.yml

@@ -1,2 +0,0 @@
-minor_changes:
-- ini - added new parameter ``allow_no_value`` to ini lookup plugin (https://github.com/ansible/ansible/issues/50594).

changelogs/fragments/55994_testcases.yml

@@ -1,3 +0,0 @@
----
-minor_changes:
-- validation testcases for check_* APIs (https://github.com/ansible/ansible/issues/55994).

changelogs/fragments/56249_recursive_diff.yml

@@ -1,2 +0,0 @@
-bugfixes:
-- recursive_diff - handle condition when parameters are not dict (https://github.com/ansible/ansible/issues/56249).

changelogs/fragments/57378-inventory-cli-unicode.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - Add unicode support to ``ansible-inventory`` CLI (https://github.com/ansible/ansible/issues/57378)

changelogs/fragments/57406-hpux-fc-info.yml

@@ -1,2 +0,0 @@
-minor_changes:
-  - facts - add fiber channel facts for HP-UX (https://github.com/ansible/ansible/pull/57406)

changelogs/fragments/61185-basic.py-fix-check_mode.yaml

@@ -1,2 +0,0 @@
-bugfixes:
-- AnsibleModule.set_mode_if_different - don't check file existence when check_mode is activated (https://github.com/ansible/ansible/issues/61185).

changelogs/fragments/62151-loop_control-until.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - loop_control - add a break_when option to to break out of a task loop early based on Jinja2 expressions (https://github.com/ansible/ansible/issues/83442).

changelogs/fragments/64092-get_url_verify_tmpsrc_checksum.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - get_url - Verify checksum using tmpsrc, not dest (https://github.com/ansible/ansible/pull/64092)

changelogs/fragments/65227.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - system_service - use a context manager for file handling.

changelogs/fragments/65386-validate-hosts.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - play - validate the ``hosts`` entry in a play (https://github.com/ansible/ansible/issues/65386)

changelogs/fragments/66349-include-role-omit.yml

@@ -1,4 +0,0 @@
-minor_changes:
-- >-
-  ``include_role`` - Allow use of ``omit`` in the ``from_*`` arguments
-  (https://github.com/ansible/ansible/issues/66349)

changelogs/fragments/66432_hostname_check_mode_writes.yml

@@ -1,7 +0,0 @@
-bugfixes:
-  - hostname - No longer modifies system files in get_* methods and therefore when consulted in check_mode (https://github.com/ansible/ansible/issues/66432)
-
-breaking_changes:
-  - hostname - Drops any remaining support for Python 2.4 by using ``with open()`` to simplify exception handling code which leaked file handles in several spots
-  - hostname - On FreeBSD, the string ``temporarystub`` no longer gets written to the hostname file in the get methods (and in check_mode). As a result, the default hostname will now appear as ``''`` (empty string) instead of ``temporarystub`` for consistency with other strategies. This means the ``before`` result will be different.
-  - hostname - On OpenRC systems and Solaris, the ``before`` value will now be ``''`` (empty string) if the permanent hostname file does not exist, for consistency with other strategies.

changelogs/fragments/67340-slurp_error_message.yml

@@ -1,2 +0,0 @@
-bugfixes:
-- "slurp - Fix error messages for unreadable files and directories(https://github.com/ansible/ansible/issues/67340)."

changelogs/fragments/67943_collection_skip.yml

@@ -1,3 +0,0 @@
----
-minor_changes:
-- collection - match skip message as per role installation.

changelogs/fragments/68525-add-varswithsources-yaml-representer.yml

@@ -1,2 +0,0 @@
-bugfixes:
-- Add yaml representer for VarsWithSources (https://github.com/ansible/ansible/pull/68525).

changelogs/fragments/69253-template-comment-attribute.yml

@@ -1,2 +0,0 @@
-minor_changes:
-  - template - Add comment attributes (``comment_start_string`` and ``comment_end_string``)