New release v2.5.13

* prevent scriptblock logging from logging payload contents
* added tests to verify no payload contents in PS Operational event log
* fix script action to send split-aware wrapper
* fix CLIXML error parser (return to -EncodedCommand exposed problems with it)
* addresses CVE-2018-16859

.azure-pipelines/azure-pipelines.yml

@@ -1,251 +0,0 @@
-trigger:
-  batch: true
-  branches:
-    include:
-      - devel
-      - stable-*
-
-pr:
-  autoCancel: true
-  branches:
-    include:
-      - devel
-      - stable-*
-
-schedules:
-  - cron: 0 7 * * *
-    displayName: Nightly
-    always: true
-    branches:
-      include:
-        - devel
-        - stable-*
-
-variables:
-  - name: checkoutPath
-    value: ansible
-  - name: coverageBranches
-    value: devel
-  - name: entryPoint
-    value: test/utils/shippable/shippable.sh
-  - name: fetchDepth
-    value: 500
-
-resources:
-  containers:
-    - container: default
-      image: quay.io/ansible/azure-pipelines-test-container:1.9.0
-
-pool: Standard
-
-stages:
-  - stage: Sanity
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-            - test: 5
-  - stage: Units
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          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'
-  - stage: Windows
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Server {0}
-          testFormat: windows/{0}/1
-          targets:
-            - test: 2012
-            - test: 2012-R2
-            - test: 2016
-            - test: 2019
-            - test: 2022
-  - stage: Remote
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        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
-          groups:
-            - 1
-            - 2
-            - 3
-            - 4
-            - 5
-  - stage: Docker
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        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
-          groups:
-            - 1
-            - 2
-            - 3
-            - 4
-            - 5
-  - stage: Galaxy
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: galaxy/{0}/1
-          targets:
-            - test: 3.8
-            - test: 3.9
-            - test: '3.10'
-  - stage: Generic
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          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
-  - stage: Incidental_Windows
-    displayName: Incidental Windows
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Server {0}
-          testFormat: i/windows/{0}
-          targets:
-            - test: 2012
-            - test: 2012-R2
-            - test: 2016
-            - test: 2019
-            - test: 2022
-  - stage: Incidental
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: i/{0}/1
-          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:
-      - Sanity
-      - Units
-      - Windows
-      - Remote
-      - Docker
-      - Galaxy
-      - Generic
-      - Incidental_Remote
-      - Incidental_Docker
-      - Incidental_Windows
-      - Incidental
-    jobs:
-      - template: templates/coverage.yml

.azure-pipelines/scripts/aggregate-coverage.sh

@@ -1,20 +0,0 @@
-#!/usr/bin/env bash
-# Aggregate code coverage results for later processing.
-
-set -o pipefail -eu
-
-agent_temp_directory="$1"
-
-PATH="${PWD}/bin:${PATH}"
-
-mkdir "${agent_temp_directory}/coverage/"
-
-options=(--venv --color -v)
-
-ansible-test coverage combine --group-by command --export "${agent_temp_directory}/coverage/" "${options[@]}"
-
-if ansible-test coverage analyze targets generate --help >/dev/null 2>&1; then
-    # Only analyze coverage if the installed version of ansible-test supports it.
-    # Doing so allows this script to work unmodified for multiple Ansible versions.
-    ansible-test coverage analyze targets generate "${agent_temp_directory}/coverage/coverage-analyze-targets.json" "${options[@]}"
-fi

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

@@ -1,60 +0,0 @@
-#!/usr/bin/env python
-"""
-Combine coverage data from multiple jobs, keeping the data only from the most recent attempt from each job.
-Coverage artifacts must be named using the format: "Coverage $(System.JobAttempt) {StableUniqueNameForEachJob}"
-The recommended coverage artifact name format is: Coverage $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)
-Keep in mind that Azure Pipelines does not enforce unique job display names (only names).
-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
-
-import os
-import re
-import shutil
-import sys
-
-
-def main():
-    """Main program entry point."""
-    source_directory = sys.argv[1]
-
-    if '/ansible_collections/' in os.getcwd():
-        output_path = "tests/output"
-    else:
-        output_path = "test/results"
-
-    destination_directory = os.path.join(output_path, 'coverage')
-
-    if not os.path.exists(destination_directory):
-        os.makedirs(destination_directory)
-
-    jobs = {}
-    count = 0
-
-    for name in os.listdir(source_directory):
-        match = re.search('^Coverage (?P<attempt>[0-9]+) (?P<label>.+)$', name)
-        label = match.group('label')
-        attempt = int(match.group('attempt'))
-        jobs[label] = max(attempt, jobs.get(label, 0))
-
-    for label, attempt in jobs.items():
-        name = 'Coverage {attempt} {label}'.format(label=label, attempt=attempt)
-        source = os.path.join(source_directory, name)
-        source_files = os.listdir(source)
-
-        for source_file in source_files:
-            source_path = os.path.join(source, source_file)
-            destination_path = os.path.join(destination_directory, source_file + '.' + label)
-            print('"%s" -> "%s"' % (source_path, destination_path))
-            shutil.copyfile(source_path, destination_path)
-            count += 1
-
-    print('Coverage file count: %d' % count)
-    print('##vso[task.setVariable variable=coverageFileCount]%d' % count)
-    print('##vso[task.setVariable variable=outputPath]%s' % output_path)
-
-
-if __name__ == '__main__':
-    main()

.azure-pipelines/scripts/process-results.sh

@@ -1,24 +0,0 @@
-#!/usr/bin/env bash
-# Check the test results and set variables for use in later steps.
-
-set -o pipefail -eu
-
-if [[ "$PWD" =~ /ansible_collections/ ]]; then
-    output_path="tests/output"
-else
-    output_path="test/results"
-fi
-
-echo "##vso[task.setVariable variable=outputPath]${output_path}"
-
-if compgen -G "${output_path}"'/junit/*.xml' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveTestResults]true"
-fi
-
-if compgen -G "${output_path}"'/bot/ansible-test-*' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveBotResults]true"
-fi
-
-if compgen -G "${output_path}"'/coverage/*' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveCoverageData]true"
-fi

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

@@ -1,101 +0,0 @@
-#!/usr/bin/env python
-"""
-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.
-"""
-
-import argparse
-import dataclasses
-import pathlib
-import shutil
-import subprocess
-import tempfile
-import typing as t
-import urllib.request
-
-
-@dataclasses.dataclass(frozen=True)
-class CoverageFile:
-    name: str
-    path: pathlib.Path
-    flags: t.List[str]
-
-
-@dataclasses.dataclass(frozen=True)
-class Args:
-    dry_run: bool
-    path: pathlib.Path
-
-
-def parse_args() -> Args:
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-n', '--dry-run', action='store_true')
-    parser.add_argument('path', type=pathlib.Path)
-
-    args = parser.parse_args()
-
-    # Store arguments in a typed dataclass
-    fields = dataclasses.fields(Args)
-    kwargs = {field.name: getattr(args, field.name) for field in fields}
-
-    return Args(**kwargs)
-
-
-def process_files(directory: pathlib.Path) -> t.Tuple[CoverageFile, ...]:
-    processed = []
-    for file in directory.joinpath('reports').glob('coverage*.xml'):
-        name = file.stem.replace('coverage=', '')
-
-        # Get flags from name
-        flags = name.replace('-powershell', '').split('=')  # Drop '-powershell' suffix
-        flags = [flag if not flag.startswith('stub') else flag.split('-')[0] for flag in flags]  # Remove "-01" from stub files
-
-        processed.append(CoverageFile(name, file, flags))
-
-    return tuple(processed)
-
-
-def upload_files(codecov_bin: pathlib.Path, files: t.Tuple[CoverageFile, ...], dry_run: bool = False) -> None:
-    for file in files:
-        cmd = [
-            str(codecov_bin),
-            '--name', file.name,
-            '--file', str(file.path),
-        ]
-        for flag in file.flags:
-            cmd.extend(['--flags', flag])
-
-        if dry_run:
-            print(f'DRY-RUN: Would run command: {cmd}')
-            continue
-
-        subprocess.run(cmd, check=True)
-
-
-def download_file(url: str, dest: pathlib.Path, flags: int, dry_run: bool = False) -> None:
-    if dry_run:
-        print(f'DRY-RUN: Would download {url} to {dest} and set mode to {flags:o}')
-        return
-
-    with urllib.request.urlopen(url) as resp:
-        with dest.open('w+b') as f:
-            # Read data in chunks rather than all at once
-            shutil.copyfileobj(resp, f, 64 * 1024)
-
-    dest.chmod(flags)
-
-
-def main():
-    args = parse_args()
-    url = 'https://ci-files.testing.ansible.com/codecov/linux/codecov'
-    with tempfile.TemporaryDirectory(prefix='codecov-') as tmpdir:
-        codecov_bin = pathlib.Path(tmpdir) / 'codecov'
-        download_file(url, codecov_bin, 0o755, args.dry_run)
-
-        files = process_files(args.path)
-        upload_files(codecov_bin, files, args.dry_run)
-
-
-if __name__ == '__main__':
-    main()

.azure-pipelines/scripts/report-coverage.sh

@@ -1,17 +0,0 @@
-#!/usr/bin/env bash
-# Generate code coverage reports for uploading to Azure Pipelines and codecov.io.
-
-set -o pipefail -eu
-
-PATH="${PWD}/bin:${PATH}"
-
-if ! ansible-test --help >/dev/null 2>&1; then
-    # Install the devel version of ansible-test for generating code coverage reports.
-    # This is only used by Ansible Collections, which are typically tested against multiple Ansible versions (in separate jobs).
-    # Since a version of ansible-test is required that can work the output from multiple older releases, the devel version is used.
-    pip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check
-fi
-
-# Generate stubs using docker (if supported) otherwise fall back to using a virtual environment instead.
-# The use of docker is required when Powershell code is present, but Ansible 2.12 was the first version to support --docker with coverage.
-ansible-test coverage xml --group-by command --stub --docker --color -v || ansible-test coverage xml --group-by command --stub --venv --color -v

.azure-pipelines/scripts/run-tests.sh

@@ -1,34 +0,0 @@
-#!/usr/bin/env bash
-# Configure the test environment and run the tests.
-
-set -o pipefail -eu
-
-entry_point="$1"
-test="$2"
-read -r -a coverage_branches <<< "$3"  # space separated list of branches to run code coverage on for scheduled builds
-
-export COMMIT_MESSAGE
-export COMPLETE
-export COVERAGE
-export IS_PULL_REQUEST
-
-if [ "${SYSTEM_PULLREQUEST_TARGETBRANCH:-}" ]; then
-    IS_PULL_REQUEST=true
-    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD^2)
-else
-    IS_PULL_REQUEST=
-    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD)
-fi
-
-COMPLETE=
-COVERAGE=
-
-if [ "${BUILD_REASON}" = "Schedule" ]; then
-    COMPLETE=yes
-
-    if printf '%s\n' "${coverage_branches[@]}" | grep -q "^${BUILD_SOURCEBRANCHNAME}$"; then
-        COVERAGE=yes
-    fi
-fi
-
-"${entry_point}" "${test}" 2>&1 | "$(dirname "$0")/time-command.py"

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

@@ -1,25 +0,0 @@
-#!/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
-
-import sys
-import time
-
-
-def main():
-    """Main program entry point."""
-    start = time.time()
-
-    sys.stdin.reconfigure(errors='surrogateescape')
-    sys.stdout.reconfigure(errors='surrogateescape')
-
-    for line in sys.stdin:
-        seconds = time.time() - start
-        sys.stdout.write('%02d:%02d %s' % (seconds // 60, seconds % 60, line))
-        sys.stdout.flush()
-
-
-if __name__ == '__main__':
-    main()

.azure-pipelines/templates/coverage.yml

@@ -1,29 +0,0 @@
-# This template adds a job for processing code coverage data.
-# It will upload results to Azure Pipelines and codecov.io.
-# Use it from a job stage that completes after all other jobs have completed.
-# This can be done by placing it in a separate summary stage that runs after the test stage(s) have completed.
-
-jobs:
-  - job: Coverage
-    displayName: Code Coverage
-    container: default
-    workspace:
-      clean: all
-    steps:
-      - checkout: self
-        fetchDepth: $(fetchDepth)
-        path: $(checkoutPath)
-      - task: DownloadPipelineArtifact@2
-        displayName: Download Coverage Data
-        inputs:
-          path: coverage/
-          patterns: "Coverage */*=coverage.combined"
-      - bash: .azure-pipelines/scripts/combine-coverage.py coverage/
-        displayName: Combine Coverage Data
-      - bash: .azure-pipelines/scripts/report-coverage.sh
-        displayName: Generate Coverage Report
-        condition: gt(variables.coverageFileCount, 0)
-      - bash: .azure-pipelines/scripts/publish-codecov.py "$(outputPath)"
-        displayName: Publish to codecov.io
-        condition: gt(variables.coverageFileCount, 0)
-        continueOnError: true

.azure-pipelines/templates/matrix.yml

@@ -1,55 +0,0 @@
-# This template uses the provided targets and optional groups to generate a matrix which is then passed to the test template.
-# If this matrix template does not provide the required functionality, consider using the test template directly instead.
-
-parameters:
-  # A required list of dictionaries, one per test target.
-  # Each item in the list must contain a "test" or "name" key.
-  # Both may be provided. If one is omitted, the other will be used.
-  - name: targets
-    type: object
-
-  # An optional list of values which will be used to multiply the targets list into a matrix.
-  # Values can be strings or numbers.
-  - name: groups
-    type: object
-    default: []
-
-  # An optional format string used to generate the job name.
-  # - {0} is the name of an item in the targets list.
-  - name: nameFormat
-    type: string
-    default: "{0}"
-
-  # An optional format string used to generate the test name.
-  # - {0} is the name of an item in the targets list.
-  - name: testFormat
-    type: string
-    default: "{0}"
-
-  # An optional format string used to add the group to the job name.
-  # {0} is the formatted name of an item in the targets list.
-  # {{1}} is the group -- be sure to include the double "{{" and "}}".
-  - name: nameGroupFormat
-    type: string
-    default: "{0} - {{1}}"
-
-  # An optional format string used to add the group to the test name.
-  # {0} is the formatted test of an item in the targets list.
-  # {{1}} is the group -- be sure to include the double "{{" and "}}".
-  - name: testGroupFormat
-    type: string
-    default: "{0}/{{1}}"
-
-jobs:
-  - template: test.yml
-    parameters:
-      jobs:
-        - ${{ if eq(length(parameters.groups), 0) }}:
-          - ${{ each target in parameters.targets }}:
-            - name: ${{ format(parameters.nameFormat, coalesce(target.name, target.test)) }}
-              test: ${{ format(parameters.testFormat, coalesce(target.test, target.name)) }}
-        - ${{ if not(eq(length(parameters.groups), 0)) }}:
-          - ${{ each group in parameters.groups }}:
-            - ${{ each target in parameters.targets }}:
-              - name: ${{ format(format(parameters.nameGroupFormat, parameters.nameFormat), coalesce(target.name, target.test), group) }}
-                test: ${{ format(format(parameters.testGroupFormat, parameters.testFormat), coalesce(target.test, target.name), group) }}

.azure-pipelines/templates/test.yml

@@ -1,45 +0,0 @@
-# This template uses the provided list of jobs to create test one or more test jobs.
-# It can be used directly if needed, or through the matrix template.
-
-parameters:
-  # A required list of dictionaries, one per test job.
-  # Each item in the list must contain a "job" and "name" key.
-  - name: jobs
-    type: object
-
-jobs:
-  - ${{ each job in parameters.jobs }}:
-    - job: test_${{ replace(replace(replace(replace(job.test, '/', '_'), '.', '_'), '-', '_'), '@', '_') }}
-      displayName: ${{ job.name }}
-      container: default
-      workspace:
-        clean: all
-      steps:
-        - checkout: self
-          fetchDepth: $(fetchDepth)
-          path: $(checkoutPath)
-        - bash: .azure-pipelines/scripts/run-tests.sh "$(entryPoint)" "${{ job.test }}" "$(coverageBranches)"
-          displayName: Run Tests
-        - bash: .azure-pipelines/scripts/process-results.sh
-          condition: succeededOrFailed()
-          displayName: Process Results
-        - bash: .azure-pipelines/scripts/aggregate-coverage.sh "$(Agent.TempDirectory)"
-          condition: eq(variables.haveCoverageData, 'true')
-          displayName: Aggregate Coverage Data
-        - task: PublishTestResults@2
-          condition: eq(variables.haveTestResults, 'true')
-          inputs:
-            testResultsFiles: "$(outputPath)/junit/*.xml"
-          displayName: Publish Test Results
-        - task: PublishPipelineArtifact@1
-          condition: eq(variables.haveBotResults, 'true')
-          displayName: Publish Bot Results
-          inputs:
-            targetPath: "$(outputPath)/bot/"
-            artifactName: "Bot $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)"
-        - task: PublishPipelineArtifact@1
-          condition: eq(variables.haveCoverageData, 'true')
-          displayName: Publish Coverage Data
-          inputs:
-            targetPath: "$(Agent.TempDirectory)/coverage/"
-            artifactName: "Coverage $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)"

.cherry_picker.toml

@@ -1,5 +0,0 @@
-team = "ansible"
-repo = "ansible"
-check_sha = "f31421576b00f0b167cdbe61217c31c21a41ac02"  # the very first commit in repo
-fix_commit_msg = false  # Don't replace "#" with "GH-"
-default_branch = "devel"

.coveragerc

@@ -0,0 +1,25 @@
+# This configuration file is used for manual execution of coverage
+# as well as for tests run through ansible-test.
+
+[run]
+branch = True
+
+# Enable concurrency. This also enables parallel mode, which results in
+# multiple coverage files being created. Concurrency allows us to collect
+# results from multiple tests simultaneously, as well as supporting multiple
+# test runs, such as from integration tests.
+concurrency = multiprocessing
+parallel = True
+
+# When running tests through ansible-test, this option is overridden by
+# the COVERAGE_FILE environment variable. This option is present for
+# convenience when running coverage manually from this directory.
+data_file = test/results/coverage/coverage
+
+# Don't collect or report code coverage from files matching these patterns.
+omit =
+    */python*/dist-packages/*
+    */python*/site-packages/*
+    */python*/distutils/*
+    */pyshared/*
+    */pytest

.gitattributes

@@ -1 +1,4 @@
+CHANGELOG.md merge=union
 .github/ export-ignore
+hacking/ export-ignore
+ticket-stubs/ export-ignore

.github/CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Community Code of Conduct
 
-Please see the official [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
+Please see the official [Ansible Community Code of Conduct](http://docs.ansible.com/ansible/latest/community.html#community-code-of-conduct).

.github/CONTRIBUTING.md

@@ -1,25 +0,0 @@
-# WELCOME TO ANSIBLE GITHUB
-
-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.
-
-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.
-
-## 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.
-
-Please review the [Community Guide](https://docs.ansible.com/ansible/latest/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).
-
-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.
-
-Thanks!

.github/ISSUE_TEMPLATE.md

@@ -1 +1,64 @@
-Please raise issues via the [new interface](https://github.com/ansible/ansible/issues/new/choose)
+<!---
+Verify first that your issue/request is not already reported on GitHub.
+Also test if the latest release, and devel branch are affected too.
+-->
+
+##### ISSUE TYPE
+<!--- Pick one below and delete the rest -->
+ - Bug Report
+ - Feature Idea
+ - Documentation Report
+
+##### COMPONENT NAME
+<!---
+Name of the module, plugin, task or feature
+Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path
+-->
+
+##### ANSIBLE VERSION
+<!--- Paste verbatim output from "ansible --version" between quotes below -->
+```
+
+```
+
+##### CONFIGURATION
+<!---
+If using Ansible 2.4 or above, paste the results of "ansible-config dump --only-changed"
+Otherwise, mention any settings you have changed/added/removed in ansible.cfg
+(or using the ANSIBLE_* environment variables).
+-->
+
+##### OS / ENVIRONMENT
+<!---
+Mention the OS you are running Ansible from, and the OS you are
+managing, or say "N/A" for anything that is not platform-specific.
+Also mention the specific version of what you are trying to control,
+e.g. if this is a network bug the version of firmware on the network device.
+-->
+
+##### SUMMARY
+<!--- Explain the problem briefly -->
+
+##### STEPS TO REPRODUCE
+<!---
+For bugs, show exactly how to reproduce the problem, using a minimal test-case.
+For new features, show how the feature would be used.
+-->
+
+<!--- Paste example playbooks or commands between quotes below -->
+```yaml
+
+```
+
+<!--- You can also paste gist.github.com links for larger files -->
+
+##### EXPECTED RESULTS
+<!--- What did you expect to happen when running the steps above? -->
+
+##### ACTUAL RESULTS
+<!--- What actually happened? If possible run with extra verbosity (-vvvv) -->
+
+<!--- Paste verbatim command output between quotes below -->
+```
+
+```

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,263 +0,0 @@
----
-name: 🐛 Bug report
-description: Create a report to help us improve
-
-body:
-- type: markdown
-  attributes:
-    value: >
-      **Thank you for wanting to report a bug in ansible-core!**
-
-
-      ⚠
-      Verify first that your issue is not [already reported on
-      GitHub][issue search] and keep in mind that we may have to keep
-      the current behavior because [every change breaks someone's
-      workflow][XKCD 1172].
-      We try to be mindful about this.
-
-      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].
-
-
-
-      [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
-
-      [issue search]: ../search?q=is%3Aissue&type=issues
-
-      [XKCD 1172]: https://xkcd.com/1172/
-
-
-- type: textarea
-  attributes:
-    label: Summary
-    description: Explain the problem briefly below.
-    placeholder: >-
-      When I try to do X with ansible-core from the devel branch on GitHub, Y
-      breaks in a way Z under the env E. Here are all the details I know
-      about this problem...
-  validations:
-    required: true
-
-- type: dropdown
-  attributes:
-    label: Issue Type
-    description: >
-      Please select the single available option in the drop-down.
-
-      <details>
-        <summary>
-          <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!_
-
-      </details>
-    # FIXME: Once GitHub allows defining the default choice, update this
-    options:
-    - Bug Report
-  validations:
-    required: true
-
-- type: input
-  attributes:
-    label: Component Name
-    description: >
-      Write the short name of the rst file, module, plugin, task or
-      feature below, *use your best guess if unsure*.
-
-
-      **Tip:** Cannot find it in this repository? Please 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: dnf, apt, yum, pip, user etc.
-  validations:
-    required: true
-
-- type: textarea
-  attributes:
-    label: Ansible Version
-    description: >-
-      Paste verbatim output from `ansible --version` below, under
-      the prompt line. Please don't wrap it with tripple backticks — your
-      whole input will be turned into a code snippet automatically.
-    render: console
-    value: |
-      $ ansible --version
-    placeholder: |
-      $ ansible --version
-      ansible [core 2.11.0b4.post0]  (detached HEAD ref: refs/) last updated 2021/04/02 00:33:35 (GMT +200)
-        config file = None
-        configured module search path = ['~/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
-        ansible python module location = ~/src/github/ansible/ansible/lib/ansible
-        ansible collection location = ~/.ansible/collections:/usr/share/ansible/collections
-        executable location = bin/ansible
-        python version = 3.9.0 (default, Oct 26 2020, 13:08:59) [GCC 10.2.0]
-        jinja version = 2.11.3
-        libyaml = True
-  validations:
-    required: true
-
-- type: textarea
-  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
-      whole input will be turned into a code snippet automatically.
-    render: console
-    value: |
-      $ ansible-config dump --only-changed
-    placeholder: |
-      $ ansible-config dump --only-changed
-      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
-  validations:
-    required: true
-
-- type: textarea
-  attributes:
-    label: OS / Environment
-    description: >-
-      Provide all relevant information below, e.g. target OS versions,
-      network device firmware, etc.
-    placeholder: RHEL 8, CentOS Stream etc.
-  validations:
-    required: true
-
-
-- type: textarea
-  attributes:
-    label: Steps to Reproduce
-    description: |
-      Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also pased any playbooks, configs and commands you used.
-
-      **HINT:** You can paste https://gist.github.com links for larger files.
-    value: |
-      <!--- Paste example playbooks or commands between quotes below -->
-      ```yaml (paste below)
-
-      ```
-    placeholder: |
-      1. Implement the following playbook:
-
-         ```yaml
-         ---
-         # ping.yml
-         - hosts: all
-           gather_facts: false
-           tasks:
-           - ping:
-         ...
-         ```
-      2. Then run `ANSIBLE_DEBUG=1 ansible-playbook ping.yml -vvvvv`
-      3. An error occurs.
-  validations:
-    required: true
-
-- type: textarea
-  attributes:
-    label: Expected Results
-    description: >-
-      Describe what you expected to happen when running the steps above.
-    placeholder: >-
-      I expected X to happen because I assumed Y and was shocked
-      that it did not.
-  validations:
-    required: true
-
-- type: textarea
-  attributes:
-    label: Actual Results
-    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
-      whole input will be turned into a code snippet automatically.
-    render: console
-    placeholder: >-
-      Certificate did not match expected hostname: files.pythonhosted.org. Certificate: {'notAfter': 'Apr 28 19:20:25 2021 GMT', 'subjectAltName': ((u'DNS', 'r.ssl.fastly.net'), (u'DNS', '*.catchpoint.com'), (u'DNS', '*.cnn.io'), (u'DNS', '*.dollarshaveclub.com'), (u'DNS', '*.eater.com'), (u'DNS', '*.fastly.picmonkey.com'), (u'DNS', '*.files.saymedia-content.com'), (u'DNS', '*.ft.com'), (u'DNS', '*.meetupstatic.com'), (u'DNS', '*.nfl.com'), (u'DNS', '*.pagar.me'), (u'DNS', '*.picmonkey.com'), (u'DNS', '*.realself.com'), (u'DNS', '*.sbnation.com'), (u'DNS', '*.shakr.com'), (u'DNS', '*.streamable.com'), (u'DNS', '*.surfly.com'), (u'DNS', '*.theverge.com'), (u'DNS', '*.thrillist.com'), (u'DNS', '*.vox-cdn.com'), (u'DNS', '*.vox.com'), (u'DNS', '*.voxmedia.com'), (u'DNS', 'eater.com'), (u'DNS', 'ft.com'), (u'DNS', 'i.gse.io'), (u'DNS', 'picmonkey.com'), (u'DNS', 'realself.com'), (u'DNS', 'static.wixstatic.com'), (u'DNS', 'streamable.com'), (u'DNS', 'surfly.com'), (u'DNS', 'theverge.com'), (u'DNS', 'vox-cdn.com'), (u'DNS', 'vox.com'), (u'DNS', 'www.joyent.com')), 'subject': ((('countryName', u'US'),), (('stateOrProvinceName', u'California'),), (('localityName', u'San Francisco'),), (('organizationName', u'Fastly, Inc'),), (('commonName', u'r.ssl.fastly.net'),))}
-      Exception:
-      Traceback (most recent call last):
-        File "/usr/local/lib/python2.6/dist-packages/pip/basecommand.py", line 215, in main
-          status = self.run(options, args)
-        File "/usr/local/lib/python2.6/dist-packages/pip/commands/install.py", line 335, in run
-          wb.build(autobuilding=True)
-        File "/usr/local/lib/python2.6/dist-packages/pip/wheel.py", line 749, in build
-          self.requirement_set.prepare_files(self.finder)
-        File "/usr/local/lib/python2.6/dist-packages/pip/req/req_set.py", line 380, in prepare_files
-          ignore_dependencies=self.ignore_dependencies))
-        File "/usr/local/lib/python2.6/dist-packages/pip/req/req_set.py", line 620, in _prepare_file
-          session=self.session, hashes=hashes)
-        File "/usr/local/lib/python2.6/dist-packages/pip/download.py", line 821, in unpack_url
-          hashes=hashes
-        File "/usr/local/lib/python2.6/dist-packages/pip/download.py", line 659, in unpack_http_url
-          hashes)
-        File "/usr/local/lib/python2.6/dist-packages/pip/download.py", line 853, in _download_http_url
-          stream=True,
-        File "/usr/local/lib/python2.6/dist-packages/pip/_vendor/requests/sessions.py", line 521, in get
-          return self.request('GET', url, **kwargs)
-        File "/usr/local/lib/python2.6/dist-packages/pip/download.py", line 386, in request
-          return super(PipSession, self).request(method, url, *args, **kwargs)
-        File "/usr/local/lib/python2.6/dist-packages/pip/_vendor/requests/sessions.py", line 508, in request
-          resp = self.send(prep, **send_kwargs)
-        File "/usr/local/lib/python2.6/dist-packages/pip/_vendor/requests/sessions.py", line 618, in send
-          r = adapter.send(request, **kwargs)
-        File "/usr/local/lib/python2.6/dist-packages/pip/_vendor/cachecontrol/adapter.py", line 47, in send
-          resp = super(CacheControlAdapter, self).send(request, **kw)
-        File "/usr/local/lib/python2.6/dist-packages/pip/_vendor/requests/adapters.py", line 506, in send
-          raise SSLError(e, request=request)
-      SSLError: HTTPSConnectionPool(host='files.pythonhosted.org', port=443): Max retries exceeded with url: /packages/ef/ab/aa12712415809bf698e719b307419f953e25344e8f42d557533d7a02b276/netapp_lib-2020.7.16-py2-none-any.whl (Caused by SSLError(CertificateError("hostname 'files.pythonhosted.org' doesn't match either of 'r.ssl.fastly.net', '*.catchpoint.com', '*.cnn.io', '*.dollarshaveclub.com', '*.eater.com', '*.fastly.picmonkey.com', '*.files.saymedia-content.com', '*.ft.com', '*.meetupstatic.com', '*.nfl.com', '*.pagar.me', '*.picmonkey.com', '*.realself.com', '*.sbnation.com', '*.shakr.com', '*.streamable.com', '*.surfly.com', '*.theverge.com', '*.thrillist.com', '*.vox-cdn.com', '*.vox.com', '*.voxmedia.com', 'eater.com', 'ft.com', 'i.gse.io', 'picmonkey.com', 'realself.com', 'static.wixstatic.com', 'streamable.com', 'surfly.com', 'theverge.com', 'vox-cdn.com', 'vox.com', 'www.joyent.com'",),))
-      ERROR: Command "/usr/bin/python2.6 /root/ansible/test/lib/ansible_test/_data/quiet_pip.py install --disable-pip-version-check -r /root/ansible/test/lib/ansible_test/_data/requirements/units.txt -r tests/unit/requirements.txt -c /root/ansible/test/lib/ansible_test/_data/requirements/constraints.txt" returned exit status 2.
-      ERROR: Command "docker exec d47eb360db4ce779c1f690db964655b76e68895c4360ff252c46fe7fe6f5c75a /usr/bin/env ANSIBLE_TEST_CONTENT_ROOT=/root/ansible_collections/netapp/ontap LC_ALL=en_US.UTF-8 /usr/bin/python3.6 /root/ansible/bin/ansible-test units --metadata tests/output/.tmp/metadata-9i2qfrcl.json --truncate 200 --redact --color yes --requirements --python default --requirements-mode only" returned exit status 1.
-  validations:
-    required: true
-
-
-- type: markdown
-  attributes:
-    value: >
-      *One last thing...*
-
-
-      *Please, complete **all** sections as described, this form
-      is [processed automatically by a robot][ansibot help].*
-
-
-      Thank you for your collaboration!
-
-
-      [ansibot help]:
-      /ansible/ansibullbot/blob/master/ISSUE_HELP.md#for-issue-submitters
-
-
-- type: checkboxes
-  attributes:
-    label: Code of Conduct
-    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
-    options:
-    - label: I agree to follow the Ansible Code of Conduct
-      required: true
-...

.github/ISSUE_TEMPLATE/config.yml

@@ -1,26 +0,0 @@
-# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
-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
-  about: |
-    Please learn how to report security vulnerabilities here.
-
-    For all security related bugs, email security@ansible.com
-    instead of using this issue tracker and you will receive
-    a prompt response.
-
-    For more information, see
-    https://docs.ansible.com/ansible/latest/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
-  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
-  about: Please ask and answer usage questions here
-- name: ⚡ Working groups
-  url: https://github.com/ansible/community/wiki
-  about: Interested in improving a specific area? Become a part of a working group!
-- name: 💼 For Enterprise
-  url: https://www.ansible.com/products/engine?utm_medium=github&utm_source=issue_template_chooser
-  about: Red Hat offers support for the Ansible Automation Platform

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -1,199 +0,0 @@
----
-name: 📝 Documentation Report
-description: Ask us about docs
-
-body:
-- type: markdown
-  attributes:
-    value: >
-      **Thank you for wanting to report a problem with ansible-core
-      documentation!**
-
-
-      Please fill out your suggestions below. If the problem seems
-      straightforward, feel free to go ahead and
-      [submit a pull request] instead!
-
-
-      ⚠
-      Verify first that your issue is not [already reported on
-      GitHub][issue search].
-
-      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].
-
-
-      [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
-
-      [issue search]: ../search?q=is%3Aissue&type=issues
-
-      [submit a pull request]:
-      https://docs.ansible.com/ansible-core/devel/community/documentation_contributions.html
-
-
-- type: textarea
-  attributes:
-    label: Summary
-    description: >
-      Explain the problem briefly below, add suggestions to wording
-      or structure.
-
-
-      **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
-      right from the GitHub UI!
-    placeholder: >-
-      I was reading the ansible-core documentation of version X and I'm having
-      problems understanding Y. It would be very helpful if that got
-      rephrased as Z.
-  validations:
-    required: true
-
-- type: dropdown
-  attributes:
-    label: Issue Type
-    description: >
-      Please select the single available option in the drop-down.
-
-      <details>
-        <summary>
-          <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!_
-
-      </details>
-    # FIXME: Once GitHub allows defining the default choice, update this
-    options:
-    - Documentation Report
-  validations:
-    required: true
-
-- type: input
-  attributes:
-    label: Component Name
-    description: >
-      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
-  validations:
-    required: true
-
-- type: textarea
-  attributes:
-    label: Ansible Version
-    description: >-
-      Paste verbatim output from `ansible --version` below, under
-      the prompt line. Please don't wrap it with tripple backticks — your
-      whole input will be turned into a code snippet automatically.
-    render: console
-    value: |
-      $ ansible --version
-    placeholder: |
-      $ ansible --version
-      ansible [core 2.11.0b4.post0]  (detached HEAD ref: refs/) last updated 2021/04/02 00:33:35 (GMT +200)
-        config file = None
-        configured module search path = ['~/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
-        ansible python module location = ~/src/github/ansible/ansible/lib/ansible
-        ansible collection location = ~/.ansible/collections:/usr/share/ansible/collections
-        executable location = bin/ansible
-        python version = 3.9.0 (default, Oct 26 2020, 13:08:59) [GCC 10.2.0]
-        jinja version = 2.11.3
-        libyaml = True
-  validations:
-    required: true
-
-- type: textarea
-  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
-      whole input will be turned into a code snippet automatically.
-    render: console
-    value: |
-      $ ansible-config dump --only-changed
-    placeholder: |
-      $ ansible-config dump --only-changed
-      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
-  validations:
-    required: true
-
-- type: textarea
-  attributes:
-    label: OS / Environment
-    description: >-
-      Provide all relevant information below, e.g. OS version,
-      browser, etc.
-    placeholder: Fedora 33, Firefox etc.
-  validations:
-    required: true
-
-
-- type: textarea
-  attributes:
-    label: Additional Information
-    description: |
-      Describe how this improves the documentation, e.g. before/after situation or screenshots.
-
-      **HINT:** You can paste https://gist.github.com links for larger files.
-    placeholder: >-
-      When the improvement is applied, it makes it more straightforward
-      to understand X.
-  validations:
-    required: true
-
-
-- type: markdown
-  attributes:
-    value: >
-      *One last thing...*
-
-
-      *Please, complete **all** sections as described, this form
-      is [processed automatically by a robot][ansibot help].*
-
-
-      Thank you for your collaboration!
-
-
-      [ansibot help]:
-      /ansible/ansibullbot/blob/master/ISSUE_HELP.md#for-issue-submitters
-
-
-- type: checkboxes
-  attributes:
-    label: Code of Conduct
-    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
-    options:
-    - label: I agree to follow the Ansible Code of Conduct
-      required: true
-...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,192 +0,0 @@
----
-name: ✨ Feature request
-description: Suggest an idea for this project
-
-body:
-- type: markdown
-  attributes:
-    value: >
-      **Thank you for wanting to suggest a feature for ansible-core!**
-
-
-
-      💡
-      Before you go ahead with your request, please first consider if it
-      would be useful for majority of the ansible-core users. As a
-      general rule of thumb, any feature that is only of interest to a
-      small sub group should be [implemented in a third-party Ansible
-      Collection][contribute to collections] or maybe even just your
-      project alone. Be mindful of the fact that the essential
-      ansible-core features have a broad impact.
-
-      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.
-
-
-      <details>
-        <summary>
-          ❗ Every change breaks someone's workflow.
-        </summary>
-
-
-        [![❗ Every change breaks someone's workflow.
-        ](https://imgs.xkcd.com/comics/workflow.png)
-        ](https://xkcd.com/1172/)
-      </details>
-
-
-      ⚠
-      Verify first that your idea is not [already requested on
-      GitHub][issue search].
-
-      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].
-
-
-
-      [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
-
-      [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
-
-      [new proposal]: ../../proposals/issues/new
-
-
-- type: textarea
-  attributes:
-    label: Summary
-    description: >
-      Describe the new feature/improvement you would like briefly below.
-
-
-      What's the problem this feature will solve?
-
-      What are you trying to do, that you are unable to achieve
-      with ansible-core as it currently stands?
-
-
-      * Provide examples of real-world use cases that this would enable
-      and how it solves the problem you described.
-
-      * How do you solve this now?
-
-      * Have you tried to work around the problem using other tools?
-
-      * Could there be a different approach to solving this issue?
-
-
-      *Know **exactly** what you want?* Consider filing a [new proposal]
-      instead outlining your research and implementation considerations.
-
-
-      [new proposal]: ../../proposals/issues/new
-    placeholder: >-
-      I am trying to do X with ansible-core from the devel branch on GitHub and
-      I think that implementing a feature Y would be very helpful for me and
-      every other user of ansible-core because of Z.
-  validations:
-    required: true
-
-- type: dropdown
-  attributes:
-    label: Issue Type
-    description: >
-      Please select the single available option in the drop-down.
-
-      <details>
-        <summary>
-          <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!_
-
-      </details>
-    # FIXME: Once GitHub allows defining the default choice, update this
-    options:
-    - Feature Idea
-  validations:
-    required: true
-
-- type: input
-  attributes:
-    label: Component Name
-    description: >
-      Write the short name of the module, plugin, task or feature below,
-      *use your best guess if unsure*.
-
-
-      Be aware that a lot of content that used to reside in this repository
-      previously, is now hosted under [individual collection
-      projects][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: dnf, apt, yum, pip, user etc.
-  validations:
-    required: true
-
-- type: textarea
-  attributes:
-    label: Additional Information
-    description: |
-      Describe how the feature would be used, why it is needed and what it would solve.
-
-      **HINT:** You can paste https://gist.github.com links for larger files.
-    value: |
-      <!--- Paste example playbooks or commands between quotes below -->
-      ```yaml (paste below)
-
-      ```
-    placeholder: >-
-      I asked on https://stackoverflow.com/.... and the community
-      advised me to do X, Y and Z.
-  validations:
-    required: true
-
-
-- type: markdown
-  attributes:
-    value: >
-      *One last thing...*
-
-
-      *Please, complete **all** sections as described, this form
-      is [processed automatically by a robot][ansibot help].*
-
-
-      Thank you for your collaboration!
-
-
-      [ansibot help]:
-      /ansible/ansibullbot/blob/master/ISSUE_HELP.md#for-issue-submitters
-
-
-- type: checkboxes
-  attributes:
-    label: Code of Conduct
-    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
-    options:
-    - label: I agree to follow the Ansible Code of Conduct
-      required: true
-...

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,23 +1,37 @@
 ##### SUMMARY
-<!--- Describe the change below, including rationale and design decisions -->
+<!--- Describe the change, including rationale and design decisions -->
 
-<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
+<!---
+If you are fixing an existing issue, please include "Fixes #nnn" in your
+commit message and your description; but you should still explain what
+the change does.
+-->
 
 ##### ISSUE TYPE
-<!--- Pick one below and delete the rest -->
-- Bugfix Pull Request
-- Docs Pull Request
-- Feature Pull Request
-- Test Pull Request
+<!--- Pick one below and delete the rest: -->
+ - Feature Pull Request
+ - New Module Pull Request
+ - Bugfix Pull Request
+ - Docs Pull Request
 
 ##### COMPONENT NAME
-<!--- Write the short name of the module, plugin, task or feature below -->
+<!--- Name of the module, plugin, module or task -->
 
-##### 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
+##### ANSIBLE VERSION
+<!--- Paste verbatim output from "ansible --version" between quotes below -->
+```
+
+```
+
+
+##### ADDITIONAL INFORMATION
+<!---
+Include additional information to help people understand the change here.
+For bugs that don't have a linked bug report, a step-by-step reproduction
+of the problem is helpful.
+  -->
+
+<!--- Paste verbatim command output below, e.g. before and after your change -->
+```
 
 ```

.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

.github/SECURITY.md

@@ -1,15 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-Ansible applies security fixes according to the 3-versions-back support
-policy. Please find more information in [our docs](
-https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#release-status
-).
-
-## Reporting a Vulnerability
-
-We encourage responsible disclosure practices for security
-vulnerabilities. Please read our [policies for reporting bugs](
-https://docs.ansible.com/ansible/devel/community/reporting_bugs_and_features.html#reporting-a-bug
-) if you want to report a security issue that might affect Ansible.

.gitignore

@@ -29,19 +29,14 @@ docs/man/man3/*
 *.sublime-project
 *.sublime-workspace
 # docsite stuff...
+docs/api/_build/
+docs/api/rst/
 docs/docsite/_build
 docs/docsite/*.html
 docs/docsite/htmlout
-docs/docsite/rst/conf.py
-docs/docsite/rst/index.rst
 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/modules/*.rst
-docs/docsite/rst/collections/*.rst
-!docs/docsite/rst/collections/all_plugins.rst
-docs/docsite/rst/collections/*/*.rst
 docs/docsite/rst/playbooks_directives.rst
 docs/docsite/rst/plugins_by_category.rst
 docs/docsite/rst/plugins/*/*.rst
@@ -62,14 +57,11 @@ credentials.yml
 # test output
 *.retry
 *.out
-.pytest_cache/
 .tox
 .cache
-.pytest_cache
 results.xml
 coverage.xml
 /test/units/cover-html
-/test/integration/inventory
 /test/integration/targets/*/backup/
 /test/cache/*
 # Development
@@ -77,27 +69,22 @@ coverage.xml
 venv
 Vagrantfile
 .vagrant
-# Backwards compatibility with `stable-2.9` and earlier branches.
-# Also used in the `devel` branch during early Ansible 2.10 development.
-/lib/ansible.egg-info/
-# First used in the `devel` branch during Ansible 2.10 development.
-/lib/ansible_base.egg-info/
-# First used in the `devel` branch during Ansible 2.11 development.
-/lib/ansible_core.egg-info/
-# vendored lib dir
-lib/ansible/_vendor/*
-!lib/ansible/_vendor/__init__.py
-# test stuff
+ansible.egg-info/
+/shippable/
 /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/
-/test/results/
-/test/integration/cloud-config-aws.yml
+/test/results/coverage/*=coverage.*
+/test/results/coverage/coverage*
+/test/results/reports/coverage*.xml
+/test/results/reports/coverage*/
+/test/results/bot/*.json
+/test/results/junit/*.xml
+/test/results/logs/*.log
+/test/results/data/*.json
+/test/integration/inventory.remote
 /test/integration/inventory.networking
 /test/integration/inventory.winrm
 /test/integration/cloud-config-aws.yml
@@ -113,6 +100,3 @@ htmlcov/
 # ansible-test coverage results
 test/units/.coverage.*
 /test/integration/cloud-config-azure.yml
-/SYMLINK_CACHE.json
-changelogs/.plugin-cache.yaml
-.ansible-test-timeout.json

.yamllint

@@ -0,0 +1 @@
+test/sanity/yamllint/config/default.yml

CHANGELOG.rst

@@ -0,0 +1 @@
+Per-version CHANGELOGS can be found `here <changelogs/>`_.

CODING_GUIDELINES.md

@@ -0,0 +1,316 @@
+Coding Guidelines
+=================
+
+Hi!  Thanks for your interest in contributing to Ansible.
+
+Here are some guidelines for contributing code.  The purpose of this document is to establish what we're looking for in code contributions, and to make sure
+new contributors know some of the conventions that we've been using.
+
+We don't think much of this should be too strange to readers familiar with contributing to Python projects, though it helps if we all get on the same page.
+
+Language
+========
+
+  * While not all components of Ansible must be in Python, core contributions to the Ansible repo must be written in Python.  This is to maximize the ability of everyone to contribute.
+  * If you want to write non-Python ansible modules or inventory scripts, that's fine, but they are not going to get merged in most likely.  Sorry!!  
+
+PEP 8 and basic style checks
+============================
+
+  * [PEP 8](https://www.python.org/dev/peps/pep-0008/) is a great Python style guide, which you should read.
+  * PEP 8 must not be strictly followed in all aspects, but most of it is good advice.
+  * The line is limited to 160 characters.
+  * To run checks for things we care about, use [ansible-test](http://docs.ansible.com/ansible/dev_guide/testing_pep8.html#running-locally).
+  * Similarly, additional checks can be made with "make pyflakes".
+  * There is no need to submit code changes for PEP 8 and pyflakes fixes, as these break attribution history.  Project leadership will make these periodically.
+  * Do not submit pull requests that simply adjust whitespace in the code.
+
+Testing
+=======
+
+  * Much of ansible's testing needs are in integration, not unit tests.  Add module tests there.
+  * That being said, there are unit tests too!
+  * Code written must absolutely pass tests (i.e. "make tests")
+  * You should anticipate any error paths in your code and test down those error paths.
+  * Additions to tests for core code are welcome, but not always possible.  Be sure things are at least well tested manually in that case.
+
+Whitespace
+==========
+
+  * Four space indent is strictly required
+  * Include meaningful whitespace between lines of code
+
+Shebang Lines
+=============
+ 
+  * /usr/bin/scripts should start with '/usr/bin/env python'
+  * module code should still use '/usr/bin/python' as this is replaced automatically by 'ansible_python_interpreter', see the FAQ in the docs for more info.
+
+Comments
+========
+
+  * Readability is one of the most important goals for this project
+  * Comment any non-trivial code where someone might not know why you are doing something in a particular way
+  * Though if something should be commented, that's often a sign someone should write a function
+  * All new functions must have a basic docstring comment
+  * Commenting above a line is preferable to commenting at the end of a line
+
+Classes
+=======
+
+  * With the exception of module code (where inline is better), it is desirable to see classes in their own files.
+  * Classes should generally not cause side effects as soon as they are instantiated, move meaningful behavior to methods rather than constructors.
+ 
+Functions and Methods
+=====================
+
+  * In general, functions should not be 'too long' and should describe a meaningful amount of work
+  * When code gets too nested, that's usually the sign the loop body could benefit from being a function
+  * Parts of our existing code are not the best examples of this at times. 
+  * Functions should have names that describe what they do, along with docstrings
+  * Functions should be named with_underscores
+  * "Don't repeat yourself" is generally a good philosophy
+
+Variables
+=========
+
+  * Use descriptive variable names instead of variables like 'x', unless x is an obvious loop index
+  * Ansible python code uses identifiers like 'ClassesLikeThis and variables_like_this
+  * Module parameters should also use_underscores and not runtogether
+
+Module Security
+===============
+
+  * Modules must take steps to avoid passing user input from the shell and always check return codes
+  * always use module.run_command instead of subprocess or Popen or os.system -- this is mandatory
+  * if you need to use the shell you must pass use_unsafe_shell=True to module.run_command
+  * if you do not need the shell, avoid using the shell
+  * any variables that can come from the user input with use_unsafe_shell=True must be wrapped by pipes.quote(x)
+  * downloads of https:// resource urls must import module_utils.urls and use the fetch_url method
+
+Misc Preferences
+================
+
+Use the dict constructor where possible when allocating dictionaries:
+
+    # not this:
+    foo = {
+       'a' : 12,
+       'b' : 34
+    }
+
+    # this:
+    foo = dict(
+       a=12,
+       b=34,
+    )
+
+Do not line up variables
+
+    # not this
+    a        = 12
+    foosball = 34
+    xyz      = 'dog'
+
+    # this
+    a = 12
+    foosball = 34
+    xyz = 'dog'
+
+Don't use line continuations:
+
+    # no
+    if (this_is_a_very_long_line and foo and \
+       i_am_going_to_continue_it):
+          bar()
+
+    # better:
+    if (this_is_a_very_long_line and foo and i_am_going_to_continue_it):
+       bar()
+
+Spacing:
+
+    # no
+    x = [1,2,3]
+
+    # no
+    x = [ 1, 2, 3 ]
+
+    # yes
+    x = [1, 2, 3]
+
+Spacing continued:
+
+    # no
+    x=foo(12)
+
+    # no
+    x = foo( 12 )
+
+    # yes
+    x = foo(12)
+
+Licenses
+========
+
+Every file should have a license header, including the copyright of the original author.  Major additions to the module are allowed
+to add an additional copyright line, and this is especially true of rewrites, but original authorship copyright messages should be preserved.
+
+All contributions to the core repo should preserve original licenses and new contributions must include the GPLv3 header.
+
+Module Documentation
+====================
+
+All module pull requests must include a DOCUMENTATION docstring (YAML format, 
+see other modules for examples) as well as an EXAMPLES docstring, which is free form.  
+
+When adding new modules, any new parameter must have a "version_added" attribute.  
+When submitting a new module, the module should have a "version_added" attribute in the 
+pull request as well, set to the current development version.
+
+Be sure to check grammar and spelling.
+
+It's frequently the case that modules get submitted with YAML that isn't valid, 
+so you can run "make webdocs" from the checkout to preview your module's documentation. 
+If it fails to build, take a look at your DOCUMENTATION string 
+or you might have a Python syntax error in there too.
+
+Python Imports
+==============
+
+To make it clear what a module is importing, imports should not be sprinkled throughout the code. 
+
+Python Imports should happen at the top of the file, exempting code from module_utils.
+
+When a conditional runtime import is required, do so something like this instead:
+
+    HAS_FOO = False
+    try:
+       import foo
+       HAS_FOO = True
+    except ImportError:
+       pass
+
+    ...
+
+    if not HAS_FOO:
+       raise Exception("the foo library is required")
+
+This makes it clear what optional dependencies are but allows this to be deferred until runtime.   In the case of module code, the raising of the Exception will be replaced
+with a "module.exit_json" call.
+
+Exceptions
+==========
+
+In the main body of the code, use typed exceptions where possible:
+    
+    # not this
+    raise Exception("panic!")
+
+    # this
+    from ansible import errors
+    ...
+    raise errors.AnsibleError("panic!")
+
+Similarly, exception checking should be fine grained:
+
+    # not this
+    try:
+       foo()
+    except:
+       bar()
+
+    # but this
+    try:
+       foo()
+    except SomeTypedException:
+       bar()
+
+List Comprehensions
+===================
+
+In general list comprehensions are always preferred to map() and filter() calls.
+
+However, they can be abused.  Optimize for readability, and avoid nesting them too deeply.
+
+Regexes
+=======
+
+There is a time and place for them, but here's an illustrative joke.
+
+"A developer had a problem, and used a regular expression to solve it.  Now the developer had two problems".
+
+Often regexes are difficult to maintain, and a trusty call to other string operations can be a great solution, faster,
+and more readable.
+
+File Conventions
+================
+
+If a piece of code looks for a named YAML file in a directory, it should assume it can take no extension, or an extension of '.yml' or '.yaml'.
+This should be true against all code that loads files.
+
+Any code that uses directories should consider the possibility that the directory may be symlink.
+
+New Ansible language parameters
+===============================
+
+If adding a new parameter, like 'can_fizzbuzz: True/False' be sure the value of the parameter is templated somewhere in the Runner code, as if anything can be parameterized in Ansible,
+there is a user that will try to parameterize it.
+
+String Find
+===========
+
+Use 'in':
+
+    # not this:
+    if x.find('foo') != -1:
+
+    # this: 
+    if 'foo' in x:
+
+String checks
+=============
+
+To test if something is a string, consider that it may be unicode.
+
+    # no
+    if type(x) == str:
+
+    # yes
+    from ansible.module_utils.six import string_types
+    if isinstance(x, string_types):
+
+Cleverness
+==========
+
+Ansible's code is intended to be read by as many people as possible, so we don't particularly encourage clever or heavily idiomatic code.
+
+In particular, metaclasses are probably not appropriate, however entertaining they may be to add.
+
+Git Practices
+=============
+
+Pull requests cannot be accepted that contain merge commits.
+
+Always do "git pull --rebase" and "git rebase" vs "git pull" or "git merge".
+
+Always create a new branch for each pull request to avoid intermingling different features or fixes on the same branch.
+
+   
+Python Version Compliance
+=========================
+
+All code in Ansible core must support a minimum version of Python 2.6.
+
+Module code must support a minimum of Python 2.4, with occasional exceptions for modules that require code that themselves require 2.6 and later.
+
+A quick reminder is that list comprehensions in Python 2.4 are not as fully fleshed out, there are no 'dict' comprehensions, and there is no 'with' statement.
+But otherwise it's pretty much all the same.
+
+The End
+=======
+
+This was not meant to be a scary document, so we hope it wasn't, but we also hope this helps you write code that is easier to maintain by others in the future.
+If you have questions about this document, please ask on the ansible-devel mailing list.
+
+Thank you!

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# WELCOME TO ANSIBLE GITHUB
+
+Hi! Nice to see you here!
+
+
+## QUESTIONS ?
+
+Please see the [community guide](http://docs.ansible.com/ansible/latest/community/index.html) for information on how to ask questions on the [mailing lists](http://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information) and IRC.
+
+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.
+
+
+## CONTRIBUTING ?
+
+Please see the [community guide](http://docs.ansible.com/ansible/latest/community/index.html) for information regarding the contribution process. Important license agreement information is also included on that page.
+
+
+## BUG TO REPORT ?
+
+First and foremost, also check the [community guide](http://docs.ansible.com/ansible/latest/community/index.html).
+
+You can report bugs or make enhancement requests at the [Ansible GitHub issue page](http://github.com/ansible/ansible/issues/new) 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. You can find the latest releases and development branch at:
+
+- https://github.com/ansible/ansible/releases
+- https://github.com/ansible/ansible/archive/devel.tar.gz
+
+Thanks!

MANIFEST.in

@@ -1,40 +1,26 @@
-include README.rst
-include COPYING
+prune ticket_stubs
+include README.rst 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 .coveragerc
+include .yamllint
+include shippable.yml
+include tox.ini
+include bin/ansible-test
 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 lib/ansible/executor/powershell *
+recursive-include lib/ansible/module_utils/powershell *
+recursive-include lib/ansible/modules *
+recursive-include lib/ansible/galaxy/data *
+recursive-include docs *
+recursive-include licenses *
 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 *
+recursive-include test *
 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 changelogs/*.rst
+include contrib/README.md
+recursive-include contrib/inventory *

MODULE_GUIDELINES.md

@@ -0,0 +1,3 @@
+# Module Maintainer Guidelines
+
+The Ansible Module Maintainer Guidelines can now be found in the [official Ansible community guide](http://docs.ansible.com/ansible/latest/community/maintainers.html).

Makefile

@@ -3,49 +3,47 @@
 # 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 srpm ----------------- produce a SRPM
+#   make rpm  ----------------- produce RPMs
 #   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)
+#   make tests ---------------- run the tests (see https://docs.ansible.com/ansible/dev_guide/testing_units.html for requirements)
+#   make pyflakes, make pep8 -- source code checks
 
 ########################################################
 # variable section
 
-NAME = ansible-core
+NAME = ansible
 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 $< $@
+MANPAGES ?= $(patsubst %.asciidoc.in,%,$(wildcard ./docs/man/man1/ansible*.1.asciidoc.in))
+ifneq ($(shell which a2x 2>/dev/null),)
+ASCII2MAN = a2x -L -D $(dir $@) -d manpage -f manpage $<
+ASCII2HTMLMAN = a2x -L -D docs/html/man/ -d manpage -f xhtml
 else
-ASCII2MAN = @echo "ERROR: rst2man from docutils command is not installed but is required to build $(MANPAGES)" && exit 1
+ASCII2MAN = @echo "ERROR: AsciiDoc 'a2x' command is not installed but is required to build $(MANPAGES)" && exit 1
 endif
+GENERATE_CLI = docs/bin/generate_man.py
 
-PYTHON ?= python
-GENERATE_CLI = hacking/build-ansible.py generate-man
+PYTHON=python
+SITELIB = $(shell $(PYTHON) -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
 
 # 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
+# if a specific release was not requested, set to 0 (RPMs have "fancier" logic for this further down)
+RELEASE ?= 1
 
 # Get the branch information from git
 ifneq ($(shell which git),)
-GIT_DATE := $(shell git log -n 1 --format="%ci")
+GIT_DATE := $(shell git log -n 1 --format="%ai")
 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)
@@ -54,32 +52,29 @@ 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)
+DATE := $(shell date -j -r $(shell git log -n 1 --format="%at") +%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)
+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
+    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)
+    DEB_RELEASE = 100.git$(DATE)$(GITINFO)
     # Do not sign unofficial builds
     DEBUILD_OPTS += -uc -us
     DPUT_OPTS += -u
@@ -95,6 +90,32 @@ PBUILDER_CACHE_DIR = /var/cache/pbuilder
 PBUILDER_BIN ?= pbuilder
 PBUILDER_OPTS ?= --debootstrapopts --variant=buildd --architecture $(PBUILDER_ARCH) --debbuildopts -b
 
+# RPM build parameters
+RPMSPECDIR= packaging/rpm
+RPMSPEC = $(RPMSPECDIR)/ansible.spec
+RPMDIST = $(shell rpm --eval '%{?dist}')
+
+ifneq ($(OFFICIAL),yes)
+    RPMRELEASE = 100.git$(DATE)$(GITINFO)
+endif
+ifeq ($(PUBLISH),nightly)
+    # https://fedoraproject.org/wiki/Packaging:Versioning#Snapshots
+    RPMRELEASE = $(RELEASE).$(DATE)git.$(GIT_HASH)
+endif
+
+RPMVERSION ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --baseversion)
+RPMRELEASE ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --rpmrelease)
+RPMNVR = "$(NAME)-$(RPMVERSION)-$(RPMRELEASE)$(RPMDIST)$(REPOTAG)"
+
+# MOCK build parameters
+MOCK_BIN ?= mock
+MOCK_CFG ?=
+
+# dynamically add repotag define only if specified
+ifneq ($(REPOTAG),)
+    EXTRA_RPM_DEFINES += --define "repotag $(REPOTAG)"
+endif
+
 # ansible-test parameters
 ANSIBLE_TEST ?= bin/ansible-test
 TEST_FLAGS ?=
@@ -120,27 +141,46 @@ tests:
 tests-py3:
 	$(ANSIBLE_TEST) units -v --python $(PYTHON3_VERSION) $(TEST_FLAGS)
 
+.PHONY: tests-nonet
+tests-nonet:
+	$(ANSIBLE_TEST) units -v --python $(PYTHON_VERSION) $(TEST_FLAGS)  --exclude test/units/modules/network/
+
 .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 $<
+.PHONY: authors
+authors:
+	sh hacking/authors.sh
 
-# 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
+# Regenerate %.1.asciidoc if %.1.asciidoc.in has been modified more
+# recently than %.1.asciidoc.
+%.1.asciidoc: %.1.asciidoc.in
+	sed "s/%VERSION%/$(VERSION)/" $< > $@
+
+# Regenerate %.1 if %.1.asciidoc or release.py has been modified more
+# recently than %.1. (Implicitly runs the %.1.asciidoc recipe)
+%.1: %.1.asciidoc lib/ansible/release.py
 	$(ASCII2MAN)
 
+.PHONY: loc
+loc:
+	sloccount lib library bin
+
+.PHONY: pep8
+pep8:
+	$(ANSIBLE_TEST) sanity --test pep8 --python $(PYTHON_VERSION) $(TEST_FLAGS)
+
+.PHONY: pyflakes
+pyflakes:
+	pyflakes lib/ansible/*.py lib/ansible/*/*.py bin/*
+
 .PHONY: clean
 clean:
 	@echo "Cleaning up distutils stuff"
 	rm -rf build
 	rm -rf dist
-	rm -rf lib/ansible*.egg-info/
+	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
@@ -149,25 +189,29 @@ clean:
 	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 -type f -name "*.asciidoc" -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 shippable/
 	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 RPM building stuff"
+	rm -rf MANIFEST rpm-build
 	@echo "Cleaning up Debian building stuff"
 	rm -rf debian
 	rm -rf deb-build
 	rm -rf docs/json
 	rm -rf docs/js
+	@echo "Cleaning up authors file"
+	rm -f AUTHORS.TXT
 	@echo "Cleaning up docsite"
 	$(MAKE) -C docs/docsite clean
+	$(MAKE) -C docs/api clean
 
 .PHONY: python
 python:
@@ -181,29 +225,92 @@ 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)
+sdist: clean docs changelog_aggregate
+	$(PYTHON) setup.py sdist
 
 .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
+# TODO: variable-ize major version number usages here
+.PHONY: changelog_reno
+changelog_reno:
+	reno -d changelogs/ report --title 'Ansible 2.5 "Kashmir" Release Notes' --collapse-pre-release --no-show-source --earliest-version v2.5.0b1 --output changelogs/CHANGELOG-v2.5.rst
+
+.PHONY: changelog_aggregate
+changelog_aggregate:
+	echo "TODO: unified changelog" > changelogs/CHANGELOG.rst
+
+.PHONY: rpmcommon
+rpmcommon: sdist
+	@mkdir -p rpm-build
+	@cp dist/*.gz rpm-build/
+	@cp $(RPMSPEC) rpm-build/$(NAME).spec
+
+.PHONY: mock-srpm
+mock-srpm: /etc/mock/$(MOCK_CFG).cfg rpmcommon
+	$(MOCK_BIN) -r $(MOCK_CFG) $(MOCK_ARGS) --resultdir rpm-build/ --bootstrap-chroot --old-chroot --buildsrpm --spec rpm-build/$(NAME).spec --sources rpm-build/ \
+    --define "rpmversion $(RPMVERSION)" \
+	--define "upstream_version $(VERSION)" \
+	--define "rpmrelease $(RPMRELEASE)" \
+	$(EXTRA_RPM_DEFINES)
+	@echo "#############################################"
+	@echo "Ansible SRPM is built:"
+	@echo rpm-build/*.src.rpm
+	@echo "#############################################"
+
+.PHONY: mock-rpm
+mock-rpm: /etc/mock/$(MOCK_CFG).cfg mock-srpm
+	$(MOCK_BIN) -r $(MOCK_CFG) $(MOCK_ARGS) --resultdir rpm-build/ --bootstrap-chroot --old-chroot --rebuild rpm-build/$(NAME)-*.src.rpm \
+    --define "rpmversion $(RPMVERSION)" \
+	--define "upstream_version $(VERSION)" \
+	--define "rpmrelease $(RPMRELEASE)" \
+	$(EXTRA_RPM_DEFINES)
+	@echo "#############################################"
+	@echo "Ansible RPM is built:"
+	@echo rpm-build/*.noarch.rpm
+	@echo "#############################################"
+
+.PHONY: srpm
+srpm: rpmcommon
+	@rpmbuild --define "_topdir %(pwd)/rpm-build" \
+	--define "_builddir %{_topdir}" \
+	--define "_rpmdir %{_topdir}" \
+	--define "_srcrpmdir %{_topdir}" \
+	--define "_specdir $(RPMSPECDIR)" \
+	--define "_sourcedir %{_topdir}" \
+	--define "upstream_version $(VERSION)" \
+	--define "rpmversion $(RPMVERSION)" \
+	--define "rpmrelease $(RPMRELEASE)" \
+	$(EXTRA_RPM_DEFINES) \
+	-bs rpm-build/$(NAME).spec
+	@rm -f rpm-build/$(NAME).spec
+	@echo "#############################################"
+	@echo "Ansible SRPM is built:"
+	@echo "    rpm-build/$(RPMNVR).src.rpm"
+	@echo "#############################################"
+
+.PHONY: rpm
+rpm: rpmcommon
+	@rpmbuild --define "_topdir %(pwd)/rpm-build" \
+	--define "_builddir %{_topdir}" \
+	--define "_rpmdir %{_topdir}" \
+	--define "_srcrpmdir %{_topdir}" \
+	--define "_specdir $(RPMSPECDIR)" \
+	--define "_sourcedir %{_topdir}" \
+	--define "_rpmfilename $(RPMNVR).%%{ARCH}.rpm" \
+	--define "__python `which $(PYTHON)`" \
+	--define "upstream_version $(VERSION)" \
+	--define "rpmversion $(RPMVERSION)" \
+	--define "rpmrelease $(RPMRELEASE)" \
+	$(EXTRA_RPM_DEFINES) \
+	-ba rpm-build/$(NAME).spec
+	@rm -f rpm-build/$(NAME).spec
+	@echo "#############################################"
+	@echo "Ansible RPM is built:"
+	@echo "    rpm-build/$(RPMNVR).noarch.rpm"
+	@echo "#############################################"
 
 .PHONY: debian
 debian: sdist
@@ -269,44 +376,25 @@ deb-src-upload: deb-src
 
 .PHONY: epub
 epub:
-	(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) 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)
+	(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
+.PHONY: generate_asciidoc
+generate_asciidoc: 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
+	PYTHONPATH=./lib $(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)
+docs: generate_asciidoc
+	make $(MANPAGES)
 
 .PHONY: alldocs
 alldocs: docs webdocs
 
 version:
 	@echo $(VERSION)
+

README.rst

@@ -1,115 +1,100 @@
-|PyPI version| |Docs badge| |Chat badge| |Build Status| |Code Of Conduct| |Mailing Lists| |License| |CII Best Practices|
+|PyPI version| |Docs badge| |Build Status|
 
 *******
 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/>`_.
+configuration-management, application deployment, cloud provisioning,
+ad-hoc task-execution, and multinode orchestration -- including
+trivializing things like zero-downtime rolling updates with load
+balancers.
+
+Read the documentation and more at https://ansible.com/
+
+You can find installation instructions
+`here <https://docs.ansible.com/intro_getting_started.html>`_ for a
+variety of platforms.
+
+Most users should probably install a released version of Ansible from ``pip``, a package manager or
+our `release repository <https://releases.ansible.com/ansible/>`_. `Officially supported
+<https://www.ansible.com/ansible-engine>`_ builds of Ansible are also available. Some power users
+run directly from the development branch - while significant efforts are made to ensure that
+``devel`` is reasonably stable, you're more likely to encounter breaking changes when running
+Ansible this way.
 
 Design Principles
 =================
 
-*  Have an extremely simple setup process with a minimal learning curve.
-*  Manage machines quickly and in parallel.
+*  Have a dead simple setup process and a minimal learning curve
+*  Manage machines very quickly and in parallel
 *  Avoid custom-agents and additional open ports, be agentless by
-   leveraging the existing SSH daemon.
+   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.
+   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.
+   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
+   Information <https://docs.ansible.com/community.html>`_ 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
+*  All code submissions are done through pull requests. Take care to
+   make sure no merge commits are in the submission, and use
+   ``git rebase`` vs ``git merge`` for this reason. If submitting a
+   large code change (other than modules), it's probably a good idea to
+   join ansible-devel and talk about what you would like to do or add
+   first to avoid duplicate efforts. This not only helps everyone
+   know what's going on, 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>`_
+*  Users list:
+   `ansible-project <https://groups.google.com/group/ansible-project>`_
+*  Development list:
+   `ansible-devel <https://groups.google.com/group/ansible-devel>`_
+*  Announcement list:
+   `ansible-announce <https://groups.google.com/group/ansible-announce>`_
+   -- read only
+*  irc.freenode.net: #ansible
 
 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.
+*  Releases are named after Led Zeppelin songs. (Releases prior to 2.0
+   were named after Van Halen songs.)
+*  The devel branch corresponds to the release actively under
+   development.
+*  Various release-X.Y branches exist for previous releases.
+*  We'd love to have your contributions, read `Community
+   Information <https://docs.ansible.com/community.html>`_ for notes on
+   how to get started.
 
 Authors
 =======
 
 Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
-and has contributions from over 5000 users (and growing). Thanks everyone!
+(michael.dehaan/gmail/com) and has contributions from over 1000 users
+(and growing). Thanks everyone!
 
-`Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc.
-<https://www.redhat.com>`_
+Ansible is sponsored by `Ansible, Inc <https://ansible.com>`_
 
 License
 =======
 
-GNU General Public License v3.0 or later
+GNU General Public License v3.0
 
 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
+.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible.svg
+   :target: https://pypi.org/project/ansible
 .. |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
+   :target: http://docs.ansible.com/ansible
+.. |Build Status| image:: https://api.shippable.com/projects/573f79d02a8192902e20e34b/badge?branch=devel
+   :target: https://app.shippable.com/projects/573f79d02a8192902e20e34b

RELEASES.txt

@@ -0,0 +1,92 @@
+Ansible Releases at a Glance
+============================
+
+VERSION  RELEASE     CODE NAME
+++++++++++++++++++++++++++++++
+
+2.5.2    2018-04-26  "Kashmir"
+2.5.1    2018-04-18  "Kashmir"
+2.5.0    2018-03-22  "Kashmir"
+2.4.4    2018-04-04  "Dancing Days"
+2.4.3    01-31.2018  "Dancing Days"
+2.4.2    11-29-2017  "Dancing Days"
+2.4.1    10-25-2017  "Dancing Days"
+2.4.0    09-19-2017  "Dancing Days"
+2.3.3    12-20-2017  "Ramble On"
+2.3.2    2017-08-04  "Ramble On"
+2.3.1    2017-06-01  "Ramble On"
+2.3.0    2017-04-12  "Ramble On"
+2.2.3    2017-05-09  "The Battle of Evermore"
+2.2.2    2017-03-27  "The Battle of Evermore"
+2.2.1    2017-01-16  "The Battle of Evermore"
+2.2.0    2016-11-01  "The Battle of Evermore"
+2.1.6    2017-06-01  "The Song Remains the Same"
+2.1.5    2017-03-27  "The Song Remains the Same"
+2.1.4    2017-01-16  "The Song Remains the Same"
+2.1.3    2016-11-04  "The Song Remains the Same"
+2.1.2    2016-09-29  "The Song Remains the Same"
+2.1.1    2016-07-28  "The Song Remains the Same"
+2.1.0    2016-05-25  "The Song Remains the Same"
+2.0.2    2016-04-19  "Over the Hills and Far Away"
+2.0.1    2016-02-24  "Over the Hills and Far Away"
+2.0.0    2016-01-12  "Over the Hills and Far Away"
+1.9.6    2016-04-15  "Dancing In the Streets"
+1.9.5    2016-03-21  "Dancing In the Streets"
+1.9.4    2015-10-09  "Dancing In the Streets"
+1.9.3    2015-09-03  "Dancing In the Streets"
+1.9.2    2015-06-24  "Dancing In the Streets"
+1.9.1    2015-04-27  "Dancing In the Streets"
+1.9.0    2015-03-25  "Dancing In the Streets"
+1.8.4    2015-02-19  "You Really Got Me"
+1.8.3    2015-02-17  "You Really Got Me"
+1.8.2    2014-12-04  "You Really Got Me"
+1.8.1    2014-11-26  "You Really Got Me"
+1.8.0    2014-11-25  "You Really Got Me"
+1.7.2    2014-09-24  "Summer Nights"
+1.7.1    2014-08-14  "Summer Nights"
+1.7.0    2014-08-06  "Summer Nights"
+1.6.10   2014-07-25  "The Cradle Will Rock"
+1.6.9    2014-07-24  "The Cradle Will Rock"
+1.6.8    2014-07-22  "The Cradle Will Rock"
+1.6.7    2014-07-21  "The Cradle Will Rock"
+1.6.6    2014-07-01  "The Cradle Will Rock"
+1.6.5    2014-06-25  "The Cradle Will Rock"
+1.6.4    2014-06-25  "The Cradle Will Rock"
+1.6.3    2014-06-09  "The Cradle Will Rock"
+1.6.2    2014-05-23  "The Cradle Will Rock"
+1.6.1    2014-05-07  "The Cradle Will Rock"
+1.6.0    2014-05-05  "The Cradle Will Rock"
+1.5.5    2014-04-18  "Love Walks In"
+1.5.4    2014-04-01  "Love Walks In"
+1.5.3    2014-03-13  "Love Walks In"
+1.5.2    2014-03-11  "Love Walks In"
+1.5.1    2014-03-10  "Love Walks In"
+1.5.0    2014-02-28  "Love Walks In"
+1.4.5    2014-02-12  "Could This Be Magic?"
+1.4.4    2014-01-06  "Could This Be Magic?"
+1.4.3    2013-12-20  "Could This Be Magic?"
+1.4.2    2013-12-18  "Could This Be Magic?"
+1.4.1    2013-11-27  "Could This Be Magic?"
+1.4.0    2013-11-21  "Could This Be Magic?"
+1.3.4    2013-10-29  "Top of the World"
+1.3.3    2013-10-09  "Top of the World"
+1.3.2    2013-09-19  "Top of the World"
+1.3.1    2013-09-16  "Top of the World"
+1.3.0    2013-09-13  "Top of the World"
+1.2.3    2013-08-21  "Right Now"
+1.2.2    2013-07-05  "Right Now"
+1.2.1    2013-07-04  "Right Now"
+1.2.0    2013-06-10  "Right Now"
+1.1.0    2013-04-02  "Mean Street"
+1.0.0    2013-02-01  "Eruption"
+0.9.0    2012-11-30  "Dreams"
+0.8.0    2012-10-19  "Cathedral"
+0.7.0    2012-09-06  "Panama"
+0.6.0    2012-08-06  "Cabo"
+0.5.0    2012-07-04  "Amsterdam"
+0.4.0    2012-05-23  "Unchained"
+0.3.0    2012-04-23  "Baluchitherium"
+0.2.0    ?           "Untitled"
+0.1.0    ?           "Untitled"
+0.0.2    ?           "Untitled"
+0.0.1    ?           "Untitled"

ROADMAP.rst

@@ -0,0 +1,17 @@
+*******************************
+Roadmap For Ansible by Red Hat
+*******************************
+This document is now the location for published Ansible Core roadmaps.
+
+The roadmap will be updated by version. Based on team and community feedback, an initial roadmap will be published for a major or minor version (2.0, 2.1).  Subminor versions will generally not have roadmaps published.
+
+2.1 was the first time Ansible has published this and asked for feedback in this manner.  So feedback on the roadmap and the new process is quite welcome.  The team is aiming for further transparency and better inclusion of both community desires and submissions.
+
+These roadmaps are the team's *best guess* roadmaps based on the Ansible team's experience and are also based on requests and feedback from the community.  There are things that may not make it on due to time constraints, lack of community maintainers, etc.  And there may be things that got missed, so each roadmap is published both as an idea of what is upcoming in Ansible, and as a medium for seeking further feedback from the community. Here are the good places for you to submit feedback:
+
+- Add to the agenda of a `Core IRC Meetings <https://github.com/ansible/community/blob/master/meetings/README.md>`_ (preferred)
+- Ansible's google-group: ansible-devel
+- AnsibleFest conferences.
+- IRC Freenode channel: #ansible-devel (this one may have things lost in lots of conversation, so a caution).
+
+Ansible Roadmaps can be found `here <http://docs.ansible.com/ansible/devel/roadmap/>`_.

bin/ansible

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

bin/ansible

@@ -0,0 +1,163 @@
+#!/usr/bin/env python
+
+# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+########################################################
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+__requires__ = ['ansible']
+try:
+    import pkg_resources
+except Exception:
+    # Use pkg_resources to find the correct versions of libraries and set
+    # sys.path appropriately when there are multiversion installs.  But we
+    # have code that better expresses the errors in the places where the code
+    # is actually used (the deps are optional for many code paths) so we don't
+    # want to fail here.
+    pass
+
+import os
+import shutil
+import sys
+import traceback
+
+from ansible.errors import AnsibleError, AnsibleOptionsError, AnsibleParserError
+from ansible.module_utils._text import to_text
+
+
+# Used for determining if the system is running a new enough python version
+# and should only restrict on our documented minimum versions
+_PY3_MIN = sys.version_info[:2] >= (3, 5)
+_PY2_MIN = (2, 6) <= sys.version_info[:2] < (3,)
+_PY_MIN = _PY3_MIN or _PY2_MIN
+if not _PY_MIN:
+    raise SystemExit('ERROR: Ansible requires a minimum of Python2 version 2.6 or Python3 version 3.5. Current version: %s' % ''.join(sys.version.splitlines()))
+
+
+class LastResort(object):
+    # OUTPUT OF LAST RESORT
+    def display(self, msg, log_only=None):
+        print(msg, file=sys.stderr)
+
+    def error(self, msg, wrap_text=None):
+        print(msg, file=sys.stderr)
+
+
+if __name__ == '__main__':
+
+    display = LastResort()
+
+    try:  # bad ANSIBLE_CONFIG or config options can force ugly stacktrace
+        import ansible.constants as C
+        from ansible.utils.display import Display
+    except AnsibleOptionsError as e:
+        display.error(to_text(e), wrap_text=False)
+        sys.exit(5)
+
+    cli = None
+    me = os.path.basename(sys.argv[0])
+
+    try:
+        display = Display()
+        display.debug("starting run")
+
+        sub = None
+        target = me.split('-')
+        if target[-1][0].isdigit():
+            # Remove any version or python version info as downstreams
+            # sometimes add that
+            target = target[:-1]
+
+        if len(target) > 1:
+            sub = target[1]
+            myclass = "%sCLI" % sub.capitalize()
+        elif target[0] == 'ansible':
+            sub = 'adhoc'
+            myclass = 'AdHocCLI'
+        else:
+            raise AnsibleError("Unknown Ansible alias: %s" % me)
+
+        try:
+            mycli = getattr(__import__("ansible.cli.%s" % sub, fromlist=[myclass]), myclass)
+        except ImportError as e:
+            # ImportError members have changed in py3
+            if 'msg' in dir(e):
+                msg = e.msg
+            else:
+                msg = e.message
+            if msg.endswith(' %s' % sub):
+                raise AnsibleError("Ansible sub-program not implemented: %s" % me)
+            else:
+                raise
+
+        try:
+            args = [to_text(a, errors='surrogate_or_strict') for a in sys.argv]
+        except UnicodeError:
+            display.error('Command line args are not in utf-8, unable to continue.  Ansible currently only understands utf-8')
+            display.display(u"The full traceback was:\n\n%s" % to_text(traceback.format_exc()))
+            exit_code = 6
+        else:
+            cli = mycli(args)
+            cli.parse()
+            exit_code = cli.run()
+
+    except AnsibleOptionsError as e:
+        cli.parser.print_help()
+        display.error(to_text(e), wrap_text=False)
+        exit_code = 5
+    except AnsibleParserError as e:
+        display.error(to_text(e), wrap_text=False)
+        exit_code = 4
+# TQM takes care of these, but leaving comment to reserve the exit codes
+#    except AnsibleHostUnreachable as e:
+#        display.error(str(e))
+#        exit_code = 3
+#    except AnsibleHostFailed as e:
+#        display.error(str(e))
+#        exit_code = 2
+    except AnsibleError as e:
+        display.error(to_text(e), wrap_text=False)
+        exit_code = 1
+    except KeyboardInterrupt:
+        display.error("User interrupted execution")
+        exit_code = 99
+    except Exception as e:
+        if C.DEFAULT_DEBUG:
+            # Show raw stacktraces in debug mode, It also allow pdb to
+            # enter post mortem mode.
+            raise
+        have_cli_options = cli is not None and cli.options is not None
+        display.error("Unexpected Exception, this is probably a bug: %s" % to_text(e), wrap_text=False)
+        if not have_cli_options or have_cli_options and cli.options.verbosity > 2:
+            log_only = False
+            if hasattr(e, 'orig_exc'):
+                display.vvv('\nexception type: %s' % to_text(type(e.orig_exc)))
+                why = to_text(e.orig_exc)
+                if to_text(e) != why:
+                    display.vvv('\noriginal msg: %s' % why)
+        else:
+            display.display("to see the full traceback, use -vvv")
+            log_only = True
+        display.display(u"the full traceback was:\n\n%s" % to_text(traceback.format_exc()), log_only=log_only)
+        exit_code = 250
+    finally:
+        # Remove ansible tmpdir
+        shutil.rmtree(C.DEFAULT_LOCAL_TMP, True)
+
+    sys.exit(exit_code)

bin/ansible-connection

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

bin/ansible-connection

@@ -0,0 +1,297 @@
+#!/usr/bin/env python
+# Copyright: (c) 2017, Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+
+__metaclass__ = type
+__requires__ = ['ansible']
+
+try:
+    import pkg_resources
+except Exception:
+    pass
+
+import fcntl
+import os
+import signal
+import socket
+import sys
+import traceback
+import errno
+import json
+
+from contextlib import contextmanager
+
+from ansible import constants as C
+from ansible.module_utils._text import to_bytes, to_native, to_text
+from ansible.module_utils.six import PY3
+from ansible.module_utils.six.moves import cPickle, StringIO
+from ansible.module_utils.connection import Connection, ConnectionError, send_data, recv_data
+from ansible.module_utils.service import fork_process
+from ansible.playbook.play_context import PlayContext
+from ansible.plugins.loader import connection_loader
+from ansible.utils.path import unfrackpath, makedirs_safe
+from ansible.utils.display import Display
+from ansible.utils.jsonrpc import JsonRpcServer
+
+
+@contextmanager
+def file_lock(lock_path):
+    """
+    Uses contextmanager to create and release a file lock based on the
+    given path. This allows us to create locks using `with file_lock()`
+    to prevent deadlocks related to failure to unlock properly.
+    """
+
+    lock_fd = os.open(lock_path, os.O_RDWR | os.O_CREAT, 0o600)
+    fcntl.lockf(lock_fd, fcntl.LOCK_EX)
+    yield
+    fcntl.lockf(lock_fd, fcntl.LOCK_UN)
+    os.close(lock_fd)
+
+
+class ConnectionProcess(object):
+    '''
+    The connection process wraps around a Connection object that manages
+    the connection to a remote device that persists over the playbook
+    '''
+    def __init__(self, fd, play_context, socket_path, original_path, ansible_playbook_pid=None):
+        self.play_context = play_context
+        self.socket_path = socket_path
+        self.original_path = original_path
+
+        self.fd = fd
+        self.exception = None
+
+        self.srv = JsonRpcServer()
+        self.sock = None
+
+        self.connection = None
+        self._ansible_playbook_pid = ansible_playbook_pid
+
+    def start(self):
+        try:
+            messages = list()
+            result = {}
+
+            messages.append('control socket path is %s' % self.socket_path)
+
+            # If this is a relative path (~ gets expanded later) then plug the
+            # key's path on to the directory we originally came from, so we can
+            # find it now that our cwd is /
+            if self.play_context.private_key_file and self.play_context.private_key_file[0] not in '~/':
+                self.play_context.private_key_file = os.path.join(self.original_path, self.play_context.private_key_file)
+            self.connection = connection_loader.get(self.play_context.connection, self.play_context, '/dev/null',
+                                                    ansible_playbook_pid=self._ansible_playbook_pid)
+            self.connection.set_options()
+            self.connection._connect()
+            self.connection._socket_path = self.socket_path
+            self.srv.register(self.connection)
+            messages.extend(sys.stdout.getvalue().splitlines())
+            messages.append('connection to remote device started successfully')
+
+            self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+            self.sock.bind(self.socket_path)
+            self.sock.listen(1)
+            messages.append('local domain socket listeners started successfully')
+        except Exception as exc:
+            result['error'] = to_text(exc)
+            result['exception'] = traceback.format_exc()
+        finally:
+            result['messages'] = messages
+            self.fd.write(json.dumps(result))
+            self.fd.close()
+
+    def run(self):
+        try:
+            while self.connection.connected:
+                signal.signal(signal.SIGALRM, self.connect_timeout)
+                signal.signal(signal.SIGTERM, self.handler)
+                signal.alarm(C.PERSISTENT_CONNECT_TIMEOUT)
+
+                self.exception = None
+                (s, addr) = self.sock.accept()
+                signal.alarm(0)
+
+                signal.signal(signal.SIGALRM, self.command_timeout)
+                while True:
+                    data = recv_data(s)
+                    if not data:
+                        break
+
+                    signal.alarm(self.connection._play_context.timeout)
+                    resp = self.srv.handle_request(data)
+                    signal.alarm(0)
+
+                    send_data(s, to_bytes(resp))
+
+                s.close()
+
+        except Exception as e:
+            # socket.accept() will raise EINTR if the socket.close() is called
+            if hasattr(e, 'errno'):
+                if e.errno != errno.EINTR:
+                    self.exception = traceback.format_exc()
+            else:
+                self.exception = traceback.format_exc()
+
+        finally:
+            # when done, close the connection properly and cleanup
+            # the socket file so it can be recreated
+            self.shutdown()
+
+    def connect_timeout(self, signum, frame):
+        display.display('persistent connection idle timeout triggered, timeout value is %s secs' % C.PERSISTENT_CONNECT_TIMEOUT, log_only=True)
+        self.shutdown()
+
+    def command_timeout(self, signum, frame):
+        display.display('command timeout triggered, timeout value is %s secs' % self.play_context.timeout, log_only=True)
+        self.shutdown()
+
+    def handler(self, signum, frame):
+        display.display('signal handler called with signal %s' % signum, log_only=True)
+        self.shutdown()
+
+    def shutdown(self):
+        """ Shuts down the local domain socket
+        """
+        if os.path.exists(self.socket_path):
+            try:
+                if self.sock:
+                    self.sock.close()
+                if self.connection:
+                    self.connection.close()
+            except:
+                pass
+            finally:
+                if os.path.exists(self.socket_path):
+                    os.remove(self.socket_path)
+                    setattr(self.connection, '_socket_path', None)
+                    setattr(self.connection, '_connected', False)
+        display.display('shutdown complete', log_only=True)
+
+
+def main():
+    """ Called to initiate the connect to the remote device
+    """
+    rc = 0
+    result = {}
+    messages = list()
+    socket_path = None
+
+    # Need stdin as a byte stream
+    if PY3:
+        stdin = sys.stdin.buffer
+    else:
+        stdin = sys.stdin
+
+    # Note: update the below log capture code after Display.display() is refactored.
+    saved_stdout = sys.stdout
+    sys.stdout = StringIO()
+
+    try:
+        # read the play context data via stdin, which means depickling it
+        cur_line = stdin.readline()
+        init_data = b''
+
+        while cur_line.strip() != b'#END_INIT#':
+            if cur_line == b'':
+                raise Exception("EOF found before init data was complete")
+            init_data += cur_line
+            cur_line = stdin.readline()
+
+        if PY3:
+            pc_data = cPickle.loads(init_data, encoding='bytes')
+        else:
+            pc_data = cPickle.loads(init_data)
+
+        play_context = PlayContext()
+        play_context.deserialize(pc_data)
+        display.verbosity = play_context.verbosity
+
+    except Exception as e:
+        rc = 1
+        result.update({
+            'error': to_text(e),
+            'exception': traceback.format_exc()
+        })
+
+    if rc == 0:
+        ssh = connection_loader.get('ssh', class_only=True)
+        ansible_playbook_pid = sys.argv[1]
+        cp = ssh._create_control_path(play_context.remote_addr, play_context.port, play_context.remote_user, play_context.connection, ansible_playbook_pid)
+
+        # create the persistent connection dir if need be and create the paths
+        # which we will be using later
+        tmp_path = unfrackpath(C.PERSISTENT_CONTROL_PATH_DIR)
+        makedirs_safe(tmp_path)
+
+        lock_path = unfrackpath("%s/.ansible_pc_lock_%s" % (tmp_path, play_context.remote_addr))
+        socket_path = unfrackpath(cp % dict(directory=tmp_path))
+
+        with file_lock(lock_path):
+            if not os.path.exists(socket_path):
+                messages.append('local domain socket does not exist, starting it')
+                original_path = os.getcwd()
+                r, w = os.pipe()
+                pid = fork_process()
+
+                if pid == 0:
+                    try:
+                        os.close(r)
+                        wfd = os.fdopen(w, 'w')
+                        process = ConnectionProcess(wfd, play_context, socket_path, original_path, ansible_playbook_pid)
+                        process.start()
+                    except Exception:
+                        messages.append(traceback.format_exc())
+                        rc = 1
+
+                    if rc == 0:
+                        process.run()
+
+                    sys.exit(rc)
+
+                else:
+                    os.close(w)
+                    rfd = os.fdopen(r, 'r')
+                    data = json.loads(rfd.read())
+                    messages.extend(data.pop('messages'))
+                    result.update(data)
+
+            else:
+                messages.append('found existing local domain socket, using it!')
+                conn = Connection(socket_path)
+                pc_data = to_text(init_data)
+                try:
+                    messages.extend(conn.update_play_context(pc_data))
+                except Exception as exc:
+                    # Only network_cli has update_play context, so missing this is
+                    # not fatal e.g. netconf
+                    if isinstance(exc, ConnectionError) and getattr(exc, 'code', None) == -32601:
+                        pass
+                    else:
+                        result.update({
+                            'error': to_text(exc),
+                            'exception': traceback.format_exc()
+                        })
+
+    messages.append(sys.stdout.getvalue())
+    result.update({
+        'messages': messages,
+        'socket_path': socket_path
+    })
+
+    sys.stdout = saved_stdout
+    if 'exception' in result:
+        rc = 1
+        sys.stderr.write(json.dumps(result))
+    else:
+        rc = 0
+        sys.stdout.write(json.dumps(result))
+
+    sys.exit(rc)
+
+
+if __name__ == '__main__':
+    display = Display()
+    main()

bin/ansible-test

@@ -1 +0,0 @@
-../test/lib/ansible_test/_util/target/cli/ansible_test_cli_stub.py

bin/ansible-test

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+# PYTHON_ARGCOMPLETE_OK
+"""Primary entry point for ansible-test."""
+
+from __future__ import (absolute_import, division, print_function)
+
+__metaclass__ = type
+
+import os
+import sys
+
+if __name__ == '__main__':
+    sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(os.path.dirname(__file__)), 'test', 'runner')))
+    import lib.cli
+    lib.cli.main()

changelogs/CHANGELOG-v2.0.rst

@@ -0,0 +1,588 @@
+=======================================================
+Ansible 2.0 "Over the Hills and Far Away" Release Notes
+=======================================================
+2.0.3 "Over the Hills and Far Away"
+-----------------------------------
+
+-  Backport fix to uri module to return the body of an error response
+-  Backport fix to uri module to handle file:/// uris.
+-  Backport fix to uri module to fix traceback when handling certain
+   server error types.
+
+2.0.2 "Over the Hills and Far Away"
+-----------------------------------
+
+-  Backport of the 2.1 feature to ensure per-item callbacks are sent as
+   they occur, rather than all at once at the end of the task.
+-  Fixed bugs related to the iteration of tasks when certain
+   combinations of roles, blocks, and includes were used, especially
+   when handling errors in rescue/always portions of blocks.
+-  Fixed handling of redirects in our helper code, and ported the uri
+   module to use this helper code. This removes the httplib dependency
+   for this module while fixing some bugs related to redirects and SSL
+   certs.
+-  Fixed some bugs related to the incorrect creation of extra temp
+   directories for uploading files, which were not cleaned up properly.
+-  Improved error reporting in certain situations, to provide more
+   information such as the playbook file/line.
+-  Fixed a bug related to the variable precedence of role parameters,
+   especially when a role may be used both as a dependency of a role and
+   directly by itself within the same play.
+-  Fixed some bugs in the 2.0 implementation of do/until.
+-  Fixed some bugs related to run\_once:
+-  Ensure that all hosts are marked as failed if a task marked as
+   run\_once fails.
+-  Show a warning when using the free strategy when a run\_once task is
+   encountered, as there is no way for the free strategy to guarantee
+   the task is not run more than once.
+-  Fixed a bug where the assemble module was not honoring check mode in
+   some situations.
+-  Fixed a bug related to delegate\_to, where we were incorrectly using
+   variables from the inventory host rather than the delegated-to host.
+-  The 'package' meta-module now properly squashes items down to a
+   single execution (as the apt/yum/other package modules do).
+-  Fixed a bug related to the ansible-galaxy CLI command dealing with
+   paged results from the Galaxy server.
+-  Pipelining support is now available for the local and jail connection
+   plugins, which is useful for users who do not wish to have temp
+   files/directories created when running tasks with these connection
+   types.
+-  Improvements in support for additional shell types.
+-  Improvements in the code which is used to calculate checksums for
+   remote files.
+-  Some speed ups and bug fixes related to the variable merging code.
+-  Workaround bug in python subprocess on El Capitan that was making
+   vault fail when attempting to encrypt a file
+-  Fix lxc\_container module having predictable temp file names and
+   setting file permissions on the temporary file too leniently on a
+   temporary file that was executed as a script. Addresses CVE-2016-3096
+-  Fix a bug in the uri module where setting headers via module params
+   that start with ``HEADER_`` were causing a traceback.
+-  Fix bug in the free strategy that was causing it to synchronize its
+   workers after every task (making it a lot more like linear than it
+   should have been).
+
+2.0.1 "Over the Hills and Far Away"
+-----------------------------------
+
+-  Fixes a major compatibility break in the synchronize module shipped
+   with 2.0.0.x. That version of synchronize ran sudo on the controller
+   prior to running rsync. In 1.9.x and previous, sudo was run on the
+   host that rsync connected to. 2.0.1 restores the 1.9.x behaviour.
+-  Additionally, several other problems with where synchronize chose to
+   run when combined with delegate\_to were fixed. In particular, if a
+   playbook targetted localhost and then delegated\_to a remote host the
+   prior behavior (in 1.9.x and 2.0.0.x) was to copy files between the
+   src and destination directories on the delegated host. This has now
+   been fixed to copy between localhost and the delegated host.
+-  Fix a regression where synchronize was unable to deal with unicode
+   paths.
+-  Fix a regression where synchronize deals with inventory hosts that
+   use localhost but with an alternate port.
+-  Fixes a regression where the retry files feature was not implemented.
+-  Fixes a regression where the any\_errors\_fatal option was
+   implemented in 2.0 incorrectly, and also adds a feature where
+   any\_errors\_fatal can be set at the block level.
+-  Fix tracebacks when playbooks or ansible itself were located in
+   directories with unicode characters.
+-  Fix bug when sending unicode characters to an external pager for
+   display.
+-  Fix a bug with squashing loops for special modules (mostly package
+   managers). The optimization was squashing when the loop did not apply
+   to the selection of packages. This has now been fixed.
+-  Temp files created when using vault are now "shredded" using the unix
+   shred program which overwrites the file with random data.
+-  Some fixes to cloudstack modules for case sensitivity
+-  Fix non-newstyle modules (non-python modules and old-style modules)
+   to disabled pipelining.
+-  Fix fetch module failing even if fail\_on\_missing is set to False
+-  Fix for cornercase when local connections, sudo, and raw were used
+   together.
+-  Fix dnf module to remove dependent packages when state=absent is
+   specified. This was a feature of the 1.9.x version that was left out
+   by mistake when the module was rewritten for 2.0.
+-  Fix bugs with non-english locales in yum, git, and apt modules
+-  Fix a bug with the dnf module where state=latest could only upgrade,
+   not install.
+-  Fix to make implicit fact gathering task correctly inherit settings
+   from play, this might cause an error if settings environment on play
+   depending on 'ansible\_env' which was previously ignored
+
+2.0 "Over the Hills and Far Away" - Jan 12, 2016
+------------------------------------------------
+
+Major Changes:
+~~~~~~~~~~~~~~
+
+-  Releases are now named after Led Zeppelin songs, 1.9 will be the last
+   Van Halen named release.
+-  The new block/rescue/always directives allow for making task blocks
+   and exception-like semantics
+-  New strategy plugins (e.g. ``free``) allow control over the flow of
+   task execution per play. The default (``linear``) will be the same as
+   before.
+-  Improved error handling, with more detailed parser messages. General
+   exception handling and display has been revamped.
+-  Task includes are now evaluated during execution, allowing more
+   dynamic includes and options. Play includes are unchanged both still
+   use the ``include`` directive.
+-  "with\_" loops can now be used with task includes since they are
+   dynamic.
+-  Callback, connection, cache and lookup plugin APIs have changed.
+   Existing plugins might require modification to work with the new
+   versions.
+-  Callbacks are now shipped in the active directory and don't need to
+   be copied, just whitelisted in ansible.cfg.
+-  Many API changes. Those integrating directly with Ansible's API will
+   encounter breaking changes, but the new API is much easier to use and
+   test.
+-  Settings are now more inheritable; what you set at play, block or
+   role will be automatically inherited by the contained tasks. This
+   allows for new features to automatically be settable at all levels,
+   previously we had to manually code this.
+-  Vars are now settable at play, block, role and task level with the
+   ``vars`` directive and scoped to the tasks contained.
+-  Template code now retains types for bools and numbers instead of
+   turning them into strings. If you need the old behaviour, quote the
+   value and it will get passed around as a string
+-  Empty variables and variables set to null in yaml will no longer be
+   converted to empty strings. They will retain the value of ``None``.
+   To go back to the old behaviour, you can override the
+   ``null_representation`` setting to an empty string in your config
+   file or by setting the ``ANSIBLE_NULL_REPRESENTATION`` environment
+   variable.
+-  Added ``meta: refresh_inventory`` to force rereading the inventory in
+   a play. This re-executes inventory scripts, but does not force them
+   to ignore any cache they might use.
+-  New delegate\_facts directive, a boolean that allows you to apply
+   facts to the delegated host (true/yes) instead of the
+   inventory\_hostname (no/false) which is the default and previous
+   behaviour.
+-  local connections now work with 'su' as a privilege escalation method
+-  Ansible 2.0 has deprecated the "ssh" from ansible\_ssh\_user,
+   ansible\_ssh\_host, and ansible\_ssh\_port to become ansible\_user,
+   ansible\_host, and ansible\_port.
+-  New ssh configuration variables (``ansible_ssh_common_args``,
+   ``ansible_ssh_extra_args``) can be used to configure a per-group or
+   per-host ssh ProxyCommand or set any other ssh options.
+   ``ansible_ssh_extra_args`` is used to set options that are accepted
+   only by ssh (not sftp or scp, which have their own analogous
+   settings).
+-  ansible-pull can now verify the code it runs when using git as a
+   source repository, using git's code signing and verification
+   features.
+-  Backslashes used when specifying parameters in jinja2 expressions in
+   YAML dicts sometimes needed to be escaped twice. This has been fixed
+   so that escaping once works. Here's an example of how playbooks need
+   to be modified:
+
+   .. code:: yaml
+
+       # Syntax in 1.9.x
+       - debug:
+           msg: "{{ 'test1_junk 1\\\\3' | regex_replace('(.*)_junk (.*)', '\\\\1 \\\\2') }}"
+       # Syntax in 2.0.x
+       - debug:
+           msg: "{{ 'test1_junk 1\\3' | regex_replace('(.*)_junk (.*)', '\\1 \\2') }}"
+
+       # Output:
+       "msg": "test1 1\\3"
+
+-  When a string with a trailing newline was specified in the playbook
+   via yaml dict format, the trailing newline was stripped. When
+   specified in key=value format the trailing newlines were kept. In v2,
+   both methods of specifying the string will keep the trailing
+   newlines. If you relied on the trailing newline being stripped you
+   can change your playbook like this:
+
+   .. code:: yaml
+
+       # Syntax in 1.9.2
+       vars:
+         message: >
+           Testing
+           some things
+       tasks:
+       - debug:
+           msg: "{{ message }}"
+
+       # Syntax in 2.0.x
+       vars:
+         old_message: >
+           Testing
+           some things
+         message: "{{ old_messsage[:-1] }}"
+       - debug:
+           msg: "{{ message }}"
+       # Output
+       "msg": "Testing some things"
+
+-  In 1.9.x, newlines in templates were converted to Unix EOL
+   conventions. If someone wanted a templated file to end up with
+   Windows or Mac EOL conventions, this could cause problems for them.
+   In 2.x newlines now remain as specified in the template file.
+
+-  When specifying complex args as a variable, the variable must use the
+   full jinja2 variable syntax ('{{var\_name}}') - bare variable names
+   there are no longer accepted. In fact, even specifying args with
+   variables has been deprecated, and will not be allowed in future
+   versions:
+
+   .. code:: yaml
+
+       ---
+       - hosts: localhost
+         connection: local
+         gather_facts: false
+         vars:
+           my_dirs:
+             - { path: /tmp/3a, state: directory, mode: 0755 }
+             - { path: /tmp/3b, state: directory, mode: 0700 }
+         tasks:
+           - file:
+             args: "{{item}}"
+             with_items: my_dirs
+
+-  The bigip\* networking modules have a new parameter, validate\_certs.
+   When True (the default) the module will validate any hosts it
+   connects to against the TLS certificates it presents when run on new
+   enough python versions. If the python version is too old to validate
+   certificates or you used certificates that cannot be validated
+   against available CAs you will need to add validate\_certs=no to your
+   playbook for those tasks.
+
+Plugins
+~~~~~~~
+
+-  Rewritten dnf module that should be faster and less prone to
+   encountering bugs in cornercases
+-  WinRM connection plugin passes all vars named ``ansible_winrm_*`` to
+   the underlying pywinrm client. This allows, for instance,
+   ``ansible_winrm_server_cert_validation=ignore`` to be used with newer
+   versions of pywinrm to disable certificate validation on Python
+   2.7.9+.
+-  WinRM connection plugin put\_file is significantly faster and no
+   longer has file size limitations.
+
+Deprecated Modules (new ones in parens):
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  ec2\_ami\_search (ec2\_ami\_find)
+-  quantum\_network (os\_network)
+-  glance\_image
+-  nova\_compute (os\_server)
+-  quantum\_floating\_ip (os\_floating\_ip)
+-  quantum\_router (os\_router)
+-  quantum\_router\_gateway (os\_router)
+-  quantum\_router\_interface (os\_router)
+
+New Modules:
+^^^^^^^^^^^^
+
+-  amazon: ec2\_ami\_copy
+-  amazon: ec2\_ami\_find
+-  amazon: ec2\_elb\_facts
+-  amazon: ec2\_eni
+-  amazon: ec2\_eni\_facts
+-  amazon: ec2\_remote\_facts
+-  amazon: ec2\_vpc\_igw
+-  amazon: ec2\_vpc\_net
+-  amazon: ec2\_vpc\_net\_facts
+-  amazon: ec2\_vpc\_route\_table
+-  amazon: ec2\_vpc\_route\_table\_facts
+-  amazon: ec2\_vpc\_subnet
+-  amazon: ec2\_vpc\_subnet\_facts
+-  amazon: ec2\_win\_password
+-  amazon: ecs\_cluster
+-  amazon: ecs\_task
+-  amazon: ecs\_taskdefinition
+-  amazon: elasticache\_subnet\_group\_facts
+-  amazon: iam
+-  amazon: iam\_cert
+-  amazon: iam\_policy
+-  amazon: route53\_facts
+-  amazon: route53\_health\_check
+-  amazon: route53\_zone
+-  amazon: sts\_assume\_role
+-  amazon: s3\_bucket
+-  amazon: s3\_lifecycle
+-  amazon: s3\_logging
+-  amazon: sqs\_queue
+-  amazon: sns\_topic
+-  amazon: sts\_assume\_role
+-  apk
+-  bigip\_gtm\_wide\_ip
+-  bundler
+-  centurylink: clc\_aa\_policy
+-  centurylink: clc\_alert\_policy
+-  centurylink: clc\_blueprint\_package
+-  centurylink: clc\_firewall\_policy
+-  centurylink: clc\_group
+-  centurylink: clc\_loadbalancer
+-  centurylink: clc\_modify\_server
+-  centurylink: clc\_publicip
+-  centurylink: clc\_server
+-  centurylink: clc\_server\_snapshot
+-  circonus\_annotation
+-  consul
+-  consul\_acl
+-  consul\_kv
+-  consul\_session
+-  cloudtrail
+-  cloudstack: cs\_account
+-  cloudstack: cs\_affinitygroup
+-  cloudstack: cs\_domain
+-  cloudstack: cs\_facts
+-  cloudstack: cs\_firewall
+-  cloudstack: cs\_iso
+-  cloudstack: cs\_instance
+-  cloudstack: cs\_instancegroup
+-  cloudstack: cs\_ip\_address
+-  cloudstack: cs\_loadbalancer\_rule
+-  cloudstack: cs\_loadbalancer\_rule\_member
+-  cloudstack: cs\_network
+-  cloudstack: cs\_portforward
+-  cloudstack: cs\_project
+-  cloudstack: cs\_sshkeypair
+-  cloudstack: cs\_securitygroup
+-  cloudstack: cs\_securitygroup\_rule
+-  cloudstack: cs\_staticnat
+-  cloudstack: cs\_template
+-  cloudstack: cs\_user
+-  cloudstack: cs\_vmsnapshot
+-  cronvar
+-  datadog\_monitor
+-  deploy\_helper
+-  docker: docker\_login
+-  dpkg\_selections
+-  elasticsearch\_plugin
+-  expect
+-  find
+-  google: gce\_tag
+-  hall
+-  ipify\_facts
+-  iptables
+-  libvirt: virt\_net
+-  libvirt: virt\_pool
+-  maven\_artifact
+-  openstack: os\_auth
+-  openstack: os\_client\_config
+-  openstack: os\_image
+-  openstack: os\_image\_facts
+-  openstack: os\_floating\_ip
+-  openstack: os\_ironic
+-  openstack: os\_ironic\_node
+-  openstack: os\_keypair
+-  openstack: os\_network
+-  openstack: os\_network\_facts
+-  openstack: os\_nova\_flavor
+-  openstack: os\_object
+-  openstack: os\_port
+-  openstack: os\_project
+-  openstack: os\_router
+-  openstack: os\_security\_group
+-  openstack: os\_security\_group\_rule
+-  openstack: os\_server
+-  openstack: os\_server\_actions
+-  openstack: os\_server\_facts
+-  openstack: os\_server\_volume
+-  openstack: os\_subnet
+-  openstack: os\_subnet\_facts
+-  openstack: os\_user
+-  openstack: os\_user\_group
+-  openstack: os\_volume
+-  openvswitch\_db.
+-  osx\_defaults
+-  pagerduty\_alert
+-  pam\_limits
+-  pear
+-  profitbricks: profitbricks
+-  profitbricks: profitbricks\_datacenter
+-  profitbricks: profitbricks\_nic
+-  profitbricks: profitbricks\_volume
+-  profitbricks: profitbricks\_volume\_attachments
+-  profitbricks: profitbricks\_snapshot
+-  proxmox: proxmox
+-  proxmox: proxmox\_template
+-  puppet
+-  pushover
+-  pushbullet
+-  rax: rax\_clb\_ssl
+-  rax: rax\_mon\_alarm
+-  rax: rax\_mon\_check
+-  rax: rax\_mon\_entity
+-  rax: rax\_mon\_notification
+-  rax: rax\_mon\_notification\_plan
+-  rabbitmq\_binding
+-  rabbitmq\_exchange
+-  rabbitmq\_queue
+-  selinux\_permissive
+-  sendgrid
+-  sensu\_check
+-  sensu\_subscription
+-  seport
+-  slackpkg
+-  solaris\_zone
+-  taiga\_issue
+-  vertica\_configuration
+-  vertica\_facts
+-  vertica\_role
+-  vertica\_schema
+-  vertica\_user
+-  vmware: vca\_fw
+-  vmware: vca\_nat
+-  vmware: vmware\_cluster
+-  vmware: vmware\_datacenter
+-  vmware: vmware\_dns\_config
+-  vmware: vmware\_dvs\_host
+-  vmware: vmware\_dvs\_portgroup
+-  vmware: vmware\_dvswitch
+-  vmware: vmware\_host
+-  vmware: vmware\_migrate\_vmk
+-  vmware: vmware\_portgroup
+-  vmware: vmware\_target\_canonical\_facts
+-  vmware: vmware\_vm\_facts
+-  vmware: vmware\_vm\_vss\_dvs\_migrate
+-  vmware: vmware\_vmkernel
+-  vmware: vmware\_vmkernel\_ip\_config
+-  vmware: vmware\_vsan\_cluster
+-  vmware: vmware\_vswitch
+-  vmware: vsphere\_copy
+-  webfaction\_app
+-  webfaction\_db
+-  webfaction\_domain
+-  webfaction\_mailbox
+-  webfaction\_site
+-  win\_acl
+-  win\_dotnet\_ngen
+-  win\_environment
+-  win\_firewall\_rule
+-  win\_iis\_virtualdirectory
+-  win\_iis\_webapplication
+-  win\_iis\_webapppool
+-  win\_iis\_webbinding
+-  win\_iis\_website
+-  win\_lineinfile
+-  win\_nssm
+-  win\_package
+-  win\_regedit
+-  win\_scheduled\_task
+-  win\_unzip
+-  win\_updates
+-  win\_webpicmd
+-  xenserver\_facts
+-  zabbix\_host
+-  zabbix\_hostmacro
+-  zabbix\_screen
+-  znode
+
+New Inventory scripts:
+^^^^^^^^^^^^^^^^^^^^^^
+
+-  cloudstack
+-  fleetctl
+-  openvz
+-  nagios\_ndo
+-  nsot
+-  proxmox
+-  rudder
+-  serf
+
+New Lookups:
+^^^^^^^^^^^^
+
+-  credstash
+-  hashi\_vault
+-  ini
+-  shelvefile
+
+New Filters:
+^^^^^^^^^^^^
+
+-  combine
+
+New Connection:
+^^^^^^^^^^^^^^^
+
+-  docker: for talking to docker containers on the ansible controller
+   machine without using ssh.
+
+New Callbacks:
+^^^^^^^^^^^^^^
+
+-  logentries: plugin to send play data to logentries service
+-  skippy: same as default but does not display skip messages
+
+Minor changes:
+~~~~~~~~~~~~~~
+
+-  Many more tests. The new API makes things more testable and we took
+   advantage of it.
+-  big\_ip modules now support turning off ssl certificate validation
+   (use only for self-signed certificates).
+-  Consolidated code from modules using urllib2 to normalize features,
+   TLS and SNI support.
+-  synchronize module's dest\_port parameter now takes precedence over
+   the ansible\_ssh\_port inventory setting.
+-  Play output is now dynamically sized to terminal with a minimum of 80
+   coluumns (old default).
+-  vars\_prompt and pause are now skipped with a warning if the play is
+   called noninteractively (i.e. pull from cron).
+-  Support for OpenBSD's 'doas' privilege escalation method.
+-  Most vault operations can now be done over multilple files.
+-  ansible-vault encrypt/decrypt read from stdin if no other input file
+   is given, and can write to a given ``--output file`` (including
+   stdout, '-'). This lets you avoid ever writing sensitive plaintext to
+   disk.
+-  ansible-vault rekey accepts the --new-vault-password-file option.
+-  ansible-vault now preserves file permissions on edit and rekey and
+   defaults to restrictive permissions for other options.
+-  Configuration items defined as paths (local only) now all support
+   shell style interpolations.
+-  Many fixes and new options added to modules, too many to list here.
+-  Now you can see task file and line number when using verbosity of 3
+   or above.
+-  The ``[x-y]`` host range syntax is no longer supported. Note that
+   ``[0:1]`` matches two hosts, i.e. the range is inclusive of its
+   endpoints.
+-  We now recommend the use of ``pattern1,pattern2`` to combine host
+   matching patterns.
+-  The use of ':' as a separator conflicts with IPv6 addresses and host
+   ranges. It will be deprecated in the future.
+-  The undocumented use of ';' as a separator is now deprecated.
+-  modules and callbacks have been extended to support no\_log to avoid
+   data disclosure.
+-  new managed\_syslog option has been added to control output to syslog
+   on managed machines, no\_log supersedes this settings.
+-  Lookup, vars and action plugin pathing has been normalized, all now
+   follow the same sequence to find relative files.
+-  We do not ignore the explicitly set login user for ssh when it
+   matches the 'current user' anymore, this allows overriding
+   .ssh/config when it is set explicitly. Leaving it unset will still
+   use the same user and respect .ssh/config. This also means
+   ansible\_ssh\_user can now return a None value.
+-  environment variables passed to remote shells now default to
+   'controller' settings, with fallback to en\_US.UTF8 which was the
+   previous default.
+-  add\_hosts is much stricter about host name and will prevent invalid
+   names from being added.
+-  ansible-pull now defaults to doing shallow checkouts with git, use
+   ``--full`` to return to previous behaviour.
+-  random cows are more random
+-  when: now gets the registered var after the first iteration, making
+   it possible to break out of item loops
+-  Handling of undefined variables has changed. In most places they will
+   now raise an error instead of silently injecting an empty string. Use
+   the default filter if you want to approximate the old behaviour:
+
+   ::
+
+       - debug: msg="The error message was: {{error_code |default('') }}"
+
+-  The yum module's detection of installed packages has been made more
+   robust by using /usr/bin/rpm in cases where it woud have used
+   repoquery before.
+-  The pip module now properly reports changes when packages are coming
+   from a VCS.
+-  Fixes for retrieving files over https when a CONNECT-only proxy is in
+   the middle.

changelogs/CHANGELOG-v2.1.rst

@@ -0,0 +1,394 @@
+=====================================================
+Ansible 2.1 "The Song Remains the Same" Release Notes
+=====================================================
+2.1.6 "The Song Remains the Same" - 06-01-2017
+----------------------------------------------
+
+-  Security fix for CVE-2017-7481 - data for lookup plugins used as
+   variables was not being correctly marked as "unsafe".
+
+2.1.5 "The Song Remains the Same" - 03-27-2017
+----------------------------------------------
+
+-  Security continued fix for CVE-2016-9587 - Handle some additional
+   corner cases in the way conditionals are parsed and evaluated.
+
+2.1.4 "The Song Remains the Same" - 2017-01-16
+----------------------------------------------
+
+-  Security fix for CVE-2016-9587 - An attacker with control over a
+   client system being managed by Ansible and the ability to send facts
+   back to the Ansible server could use this flaw to execute arbitrary
+   code on the Ansible server as the user and group Ansible is running
+   as.
+-  Fixed a bug with conditionals in loops, where undefined variables and
+   other errors will defer raising the error until the conditional has
+   been evaluated.
+-  Added a version check for jinja2-2.9, which does not fully work with
+   Ansible currently.
+
+2.1.3 "The Song Remains the Same" - 2016-11-04
+----------------------------------------------
+
+-  Security fix for CVE-2016-8628 - Command injection by compromised
+   server via fact variables. In some situations, facts returned by
+   modules could overwrite connection-based facts or some other special
+   variables, leading to injected commands running on the Ansible
+   controller as the user running Ansible (or via escalated
+   permissions).
+-  Security fix for CVE-2016-8614 - apt\_key module not properly
+   validating keys in some situations.
+
+Minor Changes:
+~~~~~~~~~~~~~~
+
+-  The subversion module from core now marks its password parameter as
+   no\_log so the password is obscured when logging.
+-  The postgresql\_lang and postgresql\_ext modules from extras now mark
+   login\_password as no\_log so the password is obscured when logging.
+-  Fixed several bugs related to locating files relative to
+   role/playbook directories.
+-  Fixed a bug in the way hosts were tested for failed states, resulting
+   in incorrectly skipped block sessions.
+-  Fixed a bug in the way our custom JSON encoder is used for the
+   ``to_json*`` filters.
+-  Fixed some bugs related to the use of non-ascii characters in become
+   passwords.
+-  Fixed a bug with Azure modules which may be using the latest rc6
+   library.
+-  Backported some docker\_common fixes.
+
+2.1.2 "The Song Remains the Same" - 2016-09-29
+----------------------------------------------
+
+Minor Changes
+~~~~~~~~~~~~~
+
+-  Fixed a bug related to creation of retry files (#17456)
+-  Fixed a bug in the way include params are used when an include task
+   is dynamic (#17064)
+-  Fixed a bug related to including blocks in an include task (#15963)
+-  Fixed a bug related to the use of hostvars internally when creating
+   the connection plugin. This prevents things like variables using
+   lookups from being evaluated unnecessarily (#17024)
+-  Fixed a bug where using a variable containing a list for the
+   ``hosts`` of a play resulted in an list of lists (#16583)
+-  Fixed a bug where integer values would cause an error if a module
+   param was of type ``float`` (no issue)
+-  Fixed a bug with net\_template failing if src was not specified
+   (#17726)
+-  Fixed a bug in "ansible-galaxy import" (#17417)
+-  Fixed a bug in which INI files incorrectly treated a hosts range as a
+   section header (#15331)
+-  Fixed a bug in which the max\_fail\_percentage calculation
+   erroneously caused a series of plays to stop executing (#15954)
+-  Fixed a bug in which the task names were not properly templated
+   (#16295)
+-  Fixed a bug causing "squashed" loops (ie. yum, apt) to incorrectly
+   report results (ansible-modules-core#4214)
+-  Fixed several bugs related to includes:
+-  when including statically, make sure that all parents were also
+   included statically (issue #16990)
+-  properly resolve nested static include paths
+-  print a message when a file is statically included
+-  Fixed a bug in which module params expected to be float types were
+   not converted from integers (only strings) (#17325)
+-  Fixed a bug introduced by static includes in 2.1, which prevented
+   notifications from going to the "top level" handler name.
+-  Fixed a bug where a group\_vars or host\_vars directory in the
+   current working directory would be used (and would take precedence)
+   over those in the inventory and/or playbook directory.
+-  Fixed a bug which could occur when the result of an async task did
+   not parse as valid JSON.
+-  (re)-allowed the use of ansible\_python\_interpreter lines with more
+   than one argument.
+-  Fixed several bugs related to the creation of the implicit localhost
+   in inventory.
+-  Fixed a bug related to an unspecified number of retries when using
+   until.
+-  Fixed a race-condition bug when creating temp directories before the
+   worker process is forked.
+-  Fix a bug with async's poll keyword not making use of
+   ansible\_python\_interpreter to run (and thus breaking when
+   /usr/bin/python is not present on the remote machine.)
+-  Fix a bug where hosts that started with a range in inventory were
+   being treated as an invalid section header.
+
+Module fixes: \* Fixed a bug where the temporary CA files created by the
+module helper code were not being deleted properly in some situations
+(#17073) \* Fixed many bugs in the unarchive module \* Fixes for module
+ec2: - Fixed a bug related to source\_dest\_check when used with non-vpc
+instances (core#3243) - Fixed a bug in ec2 where instances were not
+powering of when referenced via tags only (core#4765) - Fixed a bug
+where instances with multiple interfaces were not powering up/down
+correctly (core#3234) \* Fixes for module get\_url: - Fixed a bug in
+get\_url module to force a download if there is a checksum mismatch
+regardless of the last modified time (core#4262) - Fixed a bug in
+get\_url module to properly process FTP results (core#3661 and
+core#4601) \* Fixed a bug in win\_user related to users with disabled
+accounts/expired passwords (core#4369) \* ini\_file: - Fixed a bug where
+option lines are now inserted before blank lines. - Fixed a bug where
+leading whitespace prevented matches on options. \* Fixed a bug in
+iam\_cert when dup\_ok is used as a string. \* Fixed a bug in
+postgresql\_db related to the changed logic when state=absent. \* Fixed
+a bug where single\_transaction and quick were not passed into db\_dump
+for the mysql\_db module. \* Fixed a bug where the fetch module was not
+idempotent when retrieving the target of a symlink. \* Many minor fixes
+for bugs in extras modules.
+
+Deprecations
+~~~~~~~~~~~~
+
+-  Deprecated the use of ``_fixup_perms``. Use ``_fixup_perms2``
+   instead. This change only impacts custom action plugins using
+   ``_fixup_perms``.
+
+Incompatible Changes
+~~~~~~~~~~~~~~~~~~~~
+
+-  Use of ``_fixup_perms`` with ``recursive=True`` (the default) is no
+   longer supported. Custom action plugins using ``_fixup_perms`` will
+   require changes unless they already use ``recursive=False``. Use
+   ``_fixup_perms2`` if support for previous releases is not required.
+   Otherwise use ``_fixup_perms`` with ``recursive=False``.
+
+2.1 "The Song Remains the Same"
+-------------------------------
+
+Major Changes:
+~~~~~~~~~~~~~~
+
+-  Official support for the networking modules, originally available in
+   2.0 as a tech preview.
+-  Refactored and expanded support for Docker with new modules and many
+   improvements to existing modules, as well as a new Kubernetes module.
+-  Added new modules for Azure (see below for the full list)
+-  Added the ability to specify includes as "static" (either through a
+   configuration option or on a per-include basis). When includes are
+   static, they are loaded at compile time and cannot contain dynamic
+   features like loops.
+-  Added a new strategy ``debug``, which allows per-task debugging of
+   playbooks, for more details see
+   https://docs.ansible.com/ansible/playbooks\_debugger.html
+-  Added a new option for tasks: ``loop_control``. This currently only
+   supports one option - ``loop_var``, which allows a different loop
+   variable from ``item`` to be used.
+-  Added the ability to filter facts returned by the fact gathering
+   setup step using the ``gather_subset`` option on the play or in the
+   ansible.cfg configuration file. See
+   http://docs.ansible.com/ansible/intro\_configuration.html#gathering
+   for details on the format of the option.
+-  Added the ability to send per-item callbacks, rather than a batch
+   update (this more closely resembles the behavior of Ansible 1.x).
+-  Added facility for modules to send back 'diff' for display when
+   ansible is called with --diff, updated several modules to return this
+   info
+-  Added ansible-console tool, a REPL shell that allows running adhoc
+   tasks against a chosen inventory (based on
+   https://github.com/dominis/ansible-shell)
+-  Added two new variables, which are set when the ``rescue`` portion of
+   a ``block`` is started:
+-  ``ansible_failed_task``, which contains the serialized version of the
+   failed task.
+-  ``ansible_failed_result``, which contains the result of the failed
+   task.
+-  New meta action, ``meta: clear_host_errors`` which will clear any
+   hosts which were marked as failed (but not unreachable hosts).
+-  New meta action, ``meta: clear_facts`` which will remove existing
+   facts for the current host from current memory and facts cache.
+-  copy module can now transparently use a vaulted file as source, if
+   vault passwords were provided it will decrypt and copy on the fly.
+-  The way new-style python modules (which include all of the
+   non-windows modules shipped with Ansible) are assembled before
+   execution on the remote machine has been changed. The new way stays
+   closer to how python imports modules which will make it easier to
+   write modules which rely heavily on shared code.
+-  Reduce the situations in which a module can end up as world readable.
+   For details, see:
+   https://docs.ansible.com/ansible/become.html#becoming-an-unprivileged-user
+-  Re-implemented the retry file feature, which had been left out of 2.0
+   (fix was backported to 2.0.1 originally).
+-  Improved winrm argument validation and feature sniffing (for upcoming
+   pywinrm NTLM support).
+-  Improved winrm error handling: basic parsing of stderr from CLIXML
+   stream.
+
+New Modules
+^^^^^^^^^^^
+
+-  aws
+-  ec2\_vol\_facts
+-  ec2\_vpc\_dhcp\_options
+-  ec2\_vpc\_net\_facts
+-  ec2\_snapshot\_facts
+-  azure:
+-  azure\_rm\_deployment
+-  azure\_rm\_networkinterface
+-  azure\_rm\_networkinterface\_facts (TECH PREVIEW)
+-  azure\_rm\_publicipaddress
+-  azure\_rm\_publicipaddress\_facts (TECH PREVIEW)
+-  azure\_rm\_resourcegroup
+-  azure\_rm\_resourcegroup\_facts (TECH PREVIEW)
+-  azure\_rm\_securitygroup
+-  azure\_rm\_securitygroup\_facts (TECH PREVIEW)
+-  azure\_rm\_storageaccount
+-  azure\_rm\_storageaccount\_facts (TECH PREVIEW)
+-  azure\_rm\_storageblob
+-  azure\_rm\_subnet
+-  azure\_rm\_virtualmachine
+-  azure\_rm\_virtualmachineimage\_facts (TECH PREVIEW)
+-  azure\_rm\_virtualnetwork
+-  azure\_rm\_virtualnetwork\_facts (TECH PREVIEW)
+-  cloudflare\_dns
+-  cloudstack
+-  cs\_cluster
+-  cs\_configuration
+-  cs\_instance\_facts
+-  cs\_pod
+-  cs\_resourcelimit
+-  cs\_volume
+-  cs\_zone
+-  cs\_zone\_facts
+-  clustering
+-  kubernetes
+-  cumulus
+-  cl\_bond
+-  cl\_bridge
+-  cl\_img\_install
+-  cl\_interface
+-  cl\_interface\_policy
+-  cl\_license
+-  cl\_ports
+-  eos
+-  eos\_command
+-  eos\_config
+-  eos\_eapi
+-  eos\_template
+-  gitlab
+-  gitlab\_group
+-  gitlab\_project
+-  gitlab\_user
+-  ios
+-  ios\_command
+-  ios\_config
+-  ios\_template
+-  iosxr
+-  iosxr\_command
+-  iosxr\_config
+-  iosxr\_template
+-  junos
+-  junos\_command
+-  junos\_config
+-  junos\_facts
+-  junos\_netconf
+-  junos\_package
+-  junos\_template
+-  make
+-  mongodb\_parameter
+-  nxos
+-  nxos\_command
+-  nxos\_config
+-  nxos\_facts
+-  nxos\_feature
+-  nxos\_interface
+-  nxos\_ip\_interface
+-  nxos\_nxapi
+-  nxos\_ping
+-  nxos\_switchport
+-  nxos\_template
+-  nxos\_vlan
+-  nxos\_vrf
+-  nxos\_vrf\_interface
+-  nxos\_vrrp
+-  openstack
+-  os\_flavor\_facts
+-  os\_group
+-  os\_ironic\_inspect
+-  os\_keystone\_domain\_facts
+-  os\_keystone\_role
+-  os\_port\_facts
+-  os\_project\_facts
+-  os\_user\_facts
+-  os\_user\_role
+-  openswitch
+-  ops\_command
+-  ops\_config
+-  ops\_facts
+-  ops\_template
+-  softlayer
+-  sl\_vm
+-  vmware
+-  vmware\_maintenancemode
+-  vmware\_vm\_shell
+-  windows
+-  win\_acl\_inheritance
+-  win\_owner
+-  win\_reboot
+-  win\_regmerge
+-  win\_timezone
+-  yum\_repository
+
+New Strategies
+^^^^^^^^^^^^^^
+
+-  debug
+
+New Filters
+^^^^^^^^^^^
+
+-  extract
+-  ip4\_hex
+-  regex\_search
+-  regex\_findall
+
+New Callbacks
+^^^^^^^^^^^^^
+
+-  actionable (only shows changed and failed)
+-  slack
+-  json
+
+New Tests
+^^^^^^^^^
+
+-  issubset
+-  issuperset
+
+New Inventory scripts:
+^^^^^^^^^^^^^^^^^^^^^^
+
+-  brook
+-  rackhd
+-  azure\_rm
+
+Minor Changes:
+~~~~~~~~~~~~~~
+
+-  Added support for pipelining mode to more connection plugins, which
+   helps prevent module data from being written to disk.
+-  Added a new '!unsafe' YAML decorator, which can be used in playbooks
+   to ensure a string is not templated. For example:
+   ``foo: !unsafe "Don't template {{me}}"``.
+-  Callbacks now have access to the options with which the CLI was
+   called
+-  Debug now has verbosity option to control when to display by matching
+   number of -v in command line
+-  Modules now get verbosity, diff and other flags as passed to ansible
+-  Mount facts now also show 'network mounts' that use the pattern
+   ``<host>:/<mount>``
+-  Plugins are now sorted before loading. This means, for instance, if
+   you want two custom callback plugins to run in a certain order you
+   can name them 10-first-callback.py and 20-second-callback.py.
+-  Added (alpha) Centirfy's dzdo as another become meethod (privilege
+   escalation)
+
+Deprecations:
+~~~~~~~~~~~~~
+
+-  Deprecated the use of "bare" variables in loops (ie.
+   ``with_items: foo``, where ``foo`` is a variable). The full jinja2
+   variable syntax of ``{{foo}}`` should always be used instead. This
+   warning will be removed completely in 2.3, after which time it will
+   be an error.
+-  play\_hosts magic variable, use ansible\_play\_batch or
+   ansible\_play\_hosts instead.

changelogs/CHANGELOG-v2.12.rst

@@ -1,630 +0,0 @@
-====================================================
-ansible-core 2.12 "Dazed and Confused" Release Notes
-====================================================
-
-.. contents:: Topics
-
-
-v2.12.6
-=======
-
-Release Summary
----------------
-
-| Release Date: 2022-05-23
-| `Porting Guide <https://docs.ansible.com/ansible/devel/porting_guides.html>`__
-
-
-Bugfixes
---------
-
-- Prevent losing unsafe on results returned from lookups (https://github.com/ansible/ansible/issues/77535)
-- arg_spec - Fix incorrect ``no_log`` warning when a parameter alias is used (https://github.com/ansible/ansible/pull/77576)
-- plugin loader will now load config data for plugin by name instead of by file to avoid issues with the same file being loaded under different names (fqcn + short name).
-- variablemanager, more efficient read of vars files
-
-v2.12.5
-=======
-
-Release Summary
----------------
-
-| Release Date: 2022-04-25
-| `Porting Guide <https://docs.ansible.com/ansible/devel/porting_guides.html>`__
-
-
-Bugfixes
---------
-
-- Ansible.ModuleUtils.SID - Use user principal name as is for lookup in the ``Convert-ToSID`` function - https://github.com/ansible/ansible/issues/77316
-- Fix traceback when installing a collection from a git repository and git is not installed (https://github.com/ansible/ansible/issues/77479).
-- ansible-test - Correctly detect when running as the ``root`` user (UID 0) on the origin host. The result of the detection was incorrectly being inverted.
-- ansible-test - Fix skipping of tests marked ``needs/python`` on the origin host.
-- ansible-test - Fix skipping of tests marked ``needs/root`` on the origin host.
-- ansible-test compile sanity test - do not crash if a column could not be determined for an error (https://github.com/ansible/ansible/pull/77465).
-- hostname - use ``file_get_content()`` to read the file containing the host name in the ``FileStrategy.get_permanent_hostname()`` method. This prevents a ``TypeError`` from being raised when the strategy is used (https://github.com/ansible/ansible/issues/77025).
-- script - skip in check mode since the plugin cannot determine if a change will occur.
-- shell/command - only skip in check mode if the options `creates` and `removes` are both None.
-- winrm - Ensure ``kinit`` is run with the same ``PATH`` env var as the Ansible process
-
-v2.12.4
-=======
-
-Release Summary
----------------
-
-| Release Date: 2022-03-28
-| `Porting Guide <https://docs.ansible.com/ansible/devel/porting_guides.html>`__
-
-
-Bugfixes
---------
-
-- Add a YAML representer for ``NativeJinjaText``
-- Add a YAML representer for ``NativeJinjaUnsafeText``
-- AnsiballZ - Ensure we use the full python package in the module cache filename to avoid a case where ``collections:`` is used to execute a module via short name, where the short name duplicates another module from ``ansible.builtin`` or another collection that was executed previously.
-- Fix collection filter/test plugin redirects (https://github.com/ansible/ansible/issues/77192).
-- ansible-galaxy collection verify - display files/directories not included in the FILES.json as modified content.
-- ansible-test - Fix ``windows-integration`` and ``network-integration`` when used with the ``--docker`` option and user-provided inventory.
-- extend timeout for ansible-galaxy when communicating with the galaxy server api, and apply it to all interactions with the api
-- first_found - fix to allow for spaces in file names (https://github.com/ansible/ansible/issues/77136)
-- unarchive - the ``io_buffer_size`` option added in 2.12 was not accepted by the module (https://github.com/ansible/ansible/pull/77271).
-
-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.2.rst

@@ -0,0 +1,515 @@
+==================================================
+Ansible 2.2 "The Battle of Evermore" Release Notes
+==================================================
+2.2.4 "The Battle of Evermore" - TBD
+------------------------------------
+
+-  avoid vault view writing to logs
+-  moved htpasswd module to use LooseVersion vs StrictVersion to make
+   usable on Debian
+-  fix for adhoc not obeying callback options
+
+2.2.3 "The Battle of Evermore" - 05-09-2017
+-------------------------------------------
+
+Major Changes:
+~~~~~~~~~~~~~~
+
+-  [SECURITY] (HIGH): fix for CVE-2017-7466, which was caused by an
+   incomplete cherry-picking of commits related to CVE-2016-9587. This
+   can lead to some jinja2 syntax not being stripped out of templated
+   results.
+-  [SECURITY] (MODERATE): fix for CVE-2017-7481, in which data for
+   lookup plugins used as variables was not being correctly marked as
+   "unsafe".
+
+Minor Changes:
+~~~~~~~~~~~~~~
+
+-  Fixes a bug when using YAML inventory where hosts were not put in the
+   'all' group, and some other 'ungrouped' issues in inventory.
+-  Fixes a bug when using ansible commands without a tty for stdin.
+-  Split on newlines when searching for become prompt.
+-  Fix crash upon pass prompt in py3 when using the paramiko connection
+   type.
+
+2.2.2 "The Battle of Evermore" - 03-27-2017
+-------------------------------------------
+
+Major Changes:
+~~~~~~~~~~~~~~
+
+-  [SECURITY] (HIGH): (continued fix for CVE-2016-9587) Handle some
+   additional corner cases in the way conditionals are parsed and
+   evaluated.
+-  [SECURITY] (LOW): properly filter passwords out of URLs when
+   displaying output from some modules.
+
+Minor Changes:
+~~~~~~~~~~~~~~
+
+-  Fix azure\_rm version checks (#22270).
+-  Fix for traceback when we encounter non-utf8 characters when using
+   --diff.
+-  Ensure ssh hostkey checks respect server port.
+-  Use proper PyYAML classes for safe loading YAML files.
+-  Fix for bug related to when statements for older jinja2 versions.
+-  Fix a bug/traceback when using to\_yaml/to\_nice\_yaml.
+-  Properly clean data of jinja2-like syntax, even if that data came
+   from an unsafe source.
+-  Fix bug regarding undefined entries in HostVars.
+-  Skip fact gathering if the entire play was included via conditional
+   which evaluates to False.
+-  Fixed a performance regression when using a large number of items in
+   a with loop.
+-  Fixed a bug in the way the end of role was detected, which in some
+   cases could cause a role to be run more than once.
+-  Add jinja2 groupby filter override to cast namedtuple to tuple to
+   handle a non-compatible change in jinja2 2.9.4-2.9.5.
+-  Fixed several bugs related to temp directory creation on remote
+   systems when using shell expansions and become privilege escalation.
+-  Fixed a bug related to spliting/parsing the output of a become
+   privilege escalation when looking for a password prompt.
+-  Several unicode/bytes fixes.
+
+2.2.1 "The Battle of Evermore" - 01-16-2017
+-------------------------------------------
+
+Major Changes:
+~~~~~~~~~~~~~~
+
+-  Security fix for CVE-2016-9587 - An attacker with control over a
+   client system being managed by Ansible and the ability to send facts
+   back to the Ansible server could use this flaw to execute arbitrary
+   code on the Ansible server as the user and group Ansible is running
+   as.
+
+Minor Changes
+~~~~~~~~~~~~~
+
+-  Fixes a bug where undefined variables in with\_\* loops would cause a
+   task failure even if the when condition would cause the task to be
+   skipped.
+-  Fixed a bug related to roles where in certain situations a role may
+   be run more than once despite not allowing duplicates.
+-  Fixed some additional bugs related to atomic\_move for modules.
+-  Fixes multiple bugs related to field/attribute inheritance in nested
+   blocks and includes, as well as task iteration logic during failures.
+-  Fixed pip installing packages into virtualenvs using the system pip
+   instead of the virtualenv pip.
+-  Fixed dnf on systems with dnf-2.0.x (some changes in the API).
+-  Fixed traceback with dnf install of groups.
+-  Fixes a bug in which include\_vars was not working with failed\_when.
+-  Fix for include\_vars only loading files with .yml, .yaml, and .json
+   extensions. This was only supposed to apply to loading a directory of
+   vars files.
+-  Fixes several bugs related to properly incrementing the failed count
+   in the host statistics.
+-  Fixes a bug with listening handlers which did not specify a ``name``
+   field.
+-  Fixes a bug with the ``play_hosts`` internal variable, so that it
+   properly reflects the current list of hosts.
+-  Fixes a bug related to the v2\_playbook\_on\_start callback method
+   and legacy (v1) plugins.
+-  Fixes an openssh related process exit race condition, related to the
+   fact that connections using ControlPersist do not close stderr.
+-  Improvements and fixes to OpenBSD fact gathering.
+-  Updated ``make deb`` to use pbuilder. Use ``make local_deb`` for the
+   previous non-pbuilder build.
+-  Fixed Windows async to avoid blocking due to handle inheritance.
+-  Fixed bugs in the mount module on older Linux kernels and \*BSDs
+-  Fix regression in jinja2 include search path.
+-  Various minor fixes for Python 3
+-  Inserted some checks for jinja2-2.9, which can cause some issues with
+   Ansible currently.
+
+2.2 "The Battle of Evermore" - 11-01-2016
+-----------------------------------------
+
+Major Changes:
+~~~~~~~~~~~~~~
+
+-  Security fix for CVE-2016-8628 - Command injection by compromised
+   server via fact variables. In some situations, facts returned by
+   modules could overwrite connection-based facts or some other special
+   variables, leading to injected commands running on the Ansible
+   controller as the user running Ansible (or via escalated
+   permissions).
+-  Security fix for CVE-2016-8614 - apt\_key module not properly
+   validating keys in some situations.
+-  Added the ``listen`` feature for modules. This feature allows tasks
+   to more easily notify multiple handlers, as well as making it easier
+   for handlers from decoupled roles to be notified.
+-  Major performance improvements.
+-  Added support for binary modules
+-  Added the ability to specify serial batches as a list
+   (``serial: [1, 5, 10]``), which allows for so-called "canary" actions
+   in one play.
+-  Fixed 'local type' plugins and actions to have a more predictable
+   relative path. Fixes a regression of 1.9 (PR #16805). Existing users
+   of 2.x will need to adjust related tasks.
+-  ``meta`` tasks can now use conditionals.
+-  ``raw`` now returns ``changed: true`` to be consistent with
+   shell/command/script modules. Add ``changed_when: false`` to ``raw``
+   tasks to restore the pre-2.2 behavior if necessary.
+-  New privilege escalation become method ``ksu``
+-  Windows ``async:`` support for long-running or background tasks.
+-  Windows ``environment:`` support for setting module environment vars
+   in play/task.
+-  Added a new ``meta`` option: ``end_play``, which can be used to skip
+   to the end of a play.
+-  roles can now be included in the middle of a task list via the new
+   ``include_role`` module, this also allows for making the role import
+   'loopable' and/or conditional.
+-  The service module has been changed to use system specific modules if
+   they exist and fall back to the old service module if they cannot be
+   found or detected.
+-  Add ability to specify what ssh client binary to use on the
+   controller. This can be configured via ssh\_executable in the ansible
+   config file or by setting ansible\_ssh\_executable as an inventory
+   variable if different ones are needed for different hosts.
+-  Windows:
+-  several facts were modified or renamed for consistency with their
+   Unix counterparts, and many new facts were added. If your playbooks
+   rely on any of the following keys, please ensure they are using the
+   correct key names and/or values:
+
+   -  ansible\_date\_time.date (changed to use yyyy-mm-dd format instead
+      of default system-locale format)
+   -  ansible\_date\_time.iso8601 (changed to UTC instead of local time)
+   -  ansible\_distribution (now uses OS caption string, e.g.:
+      "Microsoft Windows Server 2012 R2 Standard", version is still
+      available on ansible\_distribution\_version)
+   -  ansible\_totalmem (renamed to ansible\_memtotal\_mb, units changed
+      to MB instead of bytes)
+
+-  ``async:`` support for long-running or background tasks.
+-  ``environment:`` support for setting module environment vars in
+   play/task.
+-  Tech Preview: Work has been done to get Ansible running under
+   Python3. This work is not complete enough to depend upon in
+   production environments but it is enough to begin testing it.
+-  Most of the controller side should now work. Users should be able to
+   run python3 /usr/bin/ansible and python3 /usr/bin/ansible-playbook
+   and have core features of ansible work.
+-  A few of the most essential modules have been audited and are known
+   to work. Others work out of the box.
+-  We are using unit and integration tests to help us port code and not
+   regress later. Even if you are not familiar with python you can still
+   help by contributing integration tests (just ansible roles) that
+   exercise more of the code to make sure it continues to run on both
+   Python2 and Python3.
+-  scp\_if\_ssh now supports True, False and "smart". "smart" is the
+   default and will retry failed sftp transfers with scp.
+-  Network:
+-  Refactored all network modules to remove duplicate code and take
+   advantage of Ansiballz implementation
+-  All functionality from \*\_template network modules have been
+   combined into \*\_config module
+-  Network \*\_command modules not longer allow configuration mode
+   statements
+
+New Modules
+^^^^^^^^^^^
+
+-  apache2\_mod\_proxy
+-  asa
+-  asa\_acl
+-  asa\_command
+-  asa\_config
+-  atomic
+-  atomic\_host
+-  atomic\_image
+-  aws
+-  cloudformation\_facts
+-  ec2\_asg\_facts
+-  ec2\_customer\_gateway
+-  ec2\_lc\_find
+-  ec2\_vpc\_dhcp\_options\_facts
+-  ec2\_vpc\_nacl
+-  ec2\_vpc\_nacl\_facts
+-  ec2\_vpc\_nat\_gateway
+-  ec2\_vpc\_peer
+-  ec2\_vpc\_vgw
+-  efs
+-  efs\_facts
+-  execute\_lambda
+-  iam\_mfa\_device\_facts
+-  iam\_server\_certificate\_facts
+-  kinesis\_stream
+-  lambda
+-  lambda\_alias
+-  lambda\_event
+-  lambda\_facts
+-  redshift
+-  redshift\_subnet\_group
+-  s3\_website
+-  sts\_session\_token
+-  cloudstack
+-  cs\_router
+-  cs\_snapshot\_policy
+-  dellos6
+-  dellos6\_command
+-  dellos6\_config
+-  dellos6\_facts
+-  dellos9
+-  dellos9\_command
+-  dellos9\_config
+-  dellos9\_facts
+-  dellos10
+-  dellos10\_command
+-  dellos10\_config
+-  dellos10\_facts
+-  digital\_ocean\_block\_storage
+-  docker
+-  docker\_network
+-  eos
+-  eos\_facts
+-  exoscale:
+-  exo\_dns\_domain
+-  exo\_dns\_record
+-  f5:
+-  bigip\_device\_dns
+-  bigip\_device\_ntp
+-  bigip\_device\_sshd
+-  bigip\_gtm\_datacenter
+-  bigip\_gtm\_virtual\_server
+-  bigip\_irule
+-  bigip\_routedomain
+-  bigip\_selfip
+-  bigip\_ssl\_certificate
+-  bigip\_sys\_db
+-  bigip\_vlan
+-  github
+-  github\_key
+-  github\_release
+-  google
+-  gcdns\_record
+-  gcdns\_zone
+-  gce\_mig
+-  honeybadger\_deployment
+-  illumos
+-  dladm\_etherstub
+-  dladm\_vnic
+-  flowadm
+-  ipadm\_if
+-  ipadm\_prop
+-  ipmi
+-  ipmi\_boot
+-  ipmi\_power
+-  ios
+-  ios\_facts
+-  iosxr
+-  iosxr\_facts
+-  include\_role
+-  jenkins
+-  jenkins\_job
+-  jenkins\_plugin
+-  kibana\_plugin
+-  letsencrypt
+-  logicmonitor
+-  logicmonitor\_facts
+-  lxd
+-  lxd\_profile
+-  lxd\_container
+-  netapp
+-  netapp\_e\_amg
+-  netapp\_e\_amg\_role
+-  netapp\_e\_amg\_sync
+-  netapp\_e\_auth
+-  netapp\_e\_facts
+-  netapp\_e\_flashcache
+-  netapp\_e\_hostgroup
+-  netapp\_e\_host
+-  netapp\_e\_lun\_mapping
+-  netapp\_e\_snapshot\_group
+-  netapp\_e\_snapshot\_images
+-  netapp\_e\_snapshot\_volume
+-  netapp\_e\_storage\_system
+-  netapp\_e\_storagepool
+-  netapp\_e\_volume
+-  netapp\_e\_volume\_copy
+-  netconf\_config
+-  netvisor
+-  pn\_cluster
+-  pn\_ospfarea
+-  pn\_ospf
+-  pn\_show
+-  pn\_trunk
+-  pn\_vlag
+-  pn\_vlan
+-  pn\_vrouterbgp
+-  pn\_vrouterif
+-  pn\_vrouterlbif
+-  pn\_vrouter
+-  nxos
+-  nxos\_aaa\_server\_host
+-  nxos\_aaa\_server
+-  nxos\_acl\_interface
+-  nxos\_acl
+-  nxos\_bgp\_af
+-  nxos\_bgp\_neighbor\_af
+-  nxos\_bgp\_neighbor
+-  nxos\_bgp
+-  nxos\_evpn\_global
+-  nxos\_evpn\_vni
+-  nxos\_file\_copy
+-  nxos\_gir\_profile\_management
+-  nxos\_gir
+-  nxos\_hsrp
+-  nxos\_igmp\_interface
+-  nxos\_igmp
+-  nxos\_igmp\_snooping
+-  nxos\_install\_os
+-  nxos\_interface\_ospf
+-  nxos\_mtu
+-  nxos\_ntp\_auth
+-  nxos\_ntp\_options
+-  nxos\_ntp
+-  nxos\_ospf
+-  nxos\_ospf\_vrf
+-  nxos\_overlay\_global
+-  nxos\_pim\_interface
+-  nxos\_pim
+-  nxos\_pim\_rp\_address
+-  nxos\_portchannel
+-  nxos\_rollback
+-  nxos\_smu
+-  nxos\_snapshot
+-  nxos\_snmp\_community
+-  nxos\_snmp\_contact
+-  nxos\_snmp\_host
+-  nxos\_snmp\_location
+-  nxos\_snmp\_traps
+-  nxos\_snmp\_user
+-  nxos\_static\_route
+-  nxos\_udld\_interface
+-  nxos\_udld
+-  nxos\_vpc\_interface
+-  nxos\_vpc
+-  nxos\_vrf\_af
+-  nxos\_vtp\_domain
+-  nxos\_vtp\_password
+-  nxos\_vtp\_version
+-  nxos\_vxlan\_vtep
+-  nxos\_vxlan\_vtep\_vni
+-  mssql\_db
+-  ovh\_ip\_loadbalancing\_backend
+-  opendj\_backendprop
+-  openstack
+-  os\_keystone\_service
+-  os\_recordset
+-  os\_server\_group
+-  os\_stack
+-  os\_zone
+-  ovirt
+-  ovirt\_auth
+-  ovirt\_disks
+-  ovirt\_vms
+-  rhevm
+-  rocketchat
+-  sefcontext
+-  sensu\_subscription
+-  smartos
+-  smartos\_image\_facts
+-  sros
+-  sros\_command
+-  sros\_config
+-  sros\_rollback
+-  statusio\_maintenance
+-  systemd
+-  telegram
+-  univention
+-  udm\_dns\_record
+-  udm\_dns\_zone
+-  udm\_group
+-  udm\_share
+-  udm\_user
+-  vmware
+-  vmware\_guest
+-  vmware\_local\_user\_manager
+-  vmware\_vmotion
+-  vyos
+-  vyos\_command
+-  vyos\_config
+-  vyos\_facts
+-  wakeonlan
+-  windows
+-  win\_command
+-  win\_robocopy
+-  win\_shell
+
+New Callbacks
+^^^^^^^^^^^^^
+
+-  foreman
+
+Minor Changes
+~~~~~~~~~~~~~
+
+-  now -vvv shows exact path from which 'currently executing module' was
+   picked up from.
+-  loop\_control now has a label option to allow fine grained control
+   what gets displayed per item
+-  loop\_control now has a pause option to allow pausing for N seconds
+   between loop iterations of a task.
+-  New privilege escalation become method ``ksu``
+-  ``raw`` now returns ``changed: true`` to be consistent with
+   shell/command/script modules. Add ``changed_when: false`` to ``raw``
+   tasks to restore the pre-2.2 behavior if necessary.
+-  removed previously deprecated ';' as host list separator.
+-  Only check if the default ssh client supports ControlPersist once
+   instead of once for each host + task combination.
+-  Fix a problem with the pip module updating the python pip package
+   itself.
+-  ansible\_play\_hosts is a new magic variable to provide a list of
+   hosts in scope for the current play. Unlike play\_hosts it is not
+   subject to the 'serial' keyword.
+-  ansible\_play\_batch is a new magic variable meant to substitute the
+   current play\_hosts.
+-  The subversion module from core now marks its password parameter as
+   no\_log so the password is obscured when logging.
+-  The postgresql\_lang and postgresql\_ext modules from extras now mark
+   login\_password as no\_log so the password is obscured when logging.
+-  Fix for yum module incorrectly thinking it succeeded in installing
+   packages
+-  Make the default ansible\_managed template string into a static
+   string since all of the replacable values lead to non-idempotent
+   behaviour.
+
+For custom front ends using the API:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  ansible.parsing.vault:
+-  VaultLib.is\_encrypted() has been deprecated. It will be removed in
+   2.4. Use ansible.parsing.vault.is\_encrypted() instead
+-  VaultFile has been removed. This unfinished code was never used
+   inside of Ansible. The feature it was intended to support has now
+   been implemented without using this.
+-  VaultAES, the older, insecure encrypted format that debuted in
+   Ansible-1.5 and was replaced by VaultAES256 less than a week later,
+   now has a deprecation warning. **It will be removed in 2.3**. In the
+   unlikely event that you wrote a vault file in that 1 week window and
+   have never modified the file since (ansible-vault automatically
+   re-encrypts the file using VaultAES256 whenever it is written to but
+   not read), run ``ansible-vault rekey [filename]`` to move to
+   VaultAES256.
+
+Removed Deprecated
+~~~~~~~~~~~~~~~~~~
+
+-  ';' as host list separator.
+-  with\_ 'bare variable' handling, now loop items must always be
+   templated ``{{ }}`` or they will be considered as plain strings.
+-  skipping task on 'missing attribute' in loop variable, now in a loop
+   an undefined attribute will return an error instead of skipping the
+   task.
+-  skipping on undefined variables in loop, now loops will have to
+   define a variable or use ``|default`` to avoid errors.
+
+Deprecations
+~~~~~~~~~~~~
+
+Notice given that the following will be removed in Ansible 2.4: \*
+Modules \* eos\_template \* ios\_template \* iosxr\_template \*
+junos\_template \* nxos\_template \* ops\_template

changelogs/CHANGELOG-v2.3.rst

@@ -0,0 +1,581 @@
+=====================================
+Ansible 2.3 "Ramble On" Release Notes
+=====================================
+2.3.4 "Ramble On" - TBD
+-----------------------
+
+-  Flush stdin when passing the become password. Fixes some cases of
+   timeout on Python3 with the ssh connection plugin:
+   https://github.com/ansible/ansible/pull/35049
+
+Bugfixes
+~~~~~~~~
+
+-  Fix setting of environment in a task that uses a loop:
+   https://github.com/ansible/ansible/issues/32685
+-  Fix https retrieval with TLSv1.2:
+   https://github.com/ansible/ansible/pull/32053
+
+2.3.3 "Ramble On" - TBD
+-----------------------
+
+Bugfixes
+~~~~~~~~
+
+-  Security fix for CVE-2017-7550 the jenkins\_plugin module was logging
+   the jenkins server password if the url\_password was passed via the
+   params field: https://github.com/ansible/ansible/pull/30875
+-  Fix alternatives module handlling of non existing options
+-  Fix synchronize traceback with the docker connection plugin
+-  Do not escape backslashes in the template lookup plugin to mirror
+   what the template module does
+-  Fix the expires option of the postgresq\_user module
+-  Fix for win\_acl when settings permissions on registry objects that
+   use ``ALL APPLICATION PACKAGES`` and
+   ``ALL RESTRICTED APPLICATION PACKAGES``
+-  Python3 fixes
+-  asorted azure modules
+-  pause module
+-  hacking/env-setup script
+-  Fix traceback when checking for passwords in logged strings when
+   logging executed commands.
+-  docker\_login module
+-  Workaround python-libselinux API change in the seboolean module
+-  digital\_ocean\_tag module
+-  Fix the zip filter
+-  Fix user module combining bytes and text
+-  Fix for security groups in the amazon efs module
+-  Fix for the jail connection plugin not finding the named jail
+-  Fix for blockinfile's parameters insertbefore and insertafter
+-  ios\_config: Fix traceback when the efaults parameter is not set
+-  iosxr\_config: Fixed unicode error when UTF-8 characters are in
+   configs
+-  Fix check mode in archive module
+-  Fix UnboundLocalError in check mode in cs\_role module
+-  Fix to always use lowercase hostnames for host keys in known\_hosts
+   module
+-  Added missing return results for win\_stat
+-  Fix rabbitmq modules to give a helpful error if requests is not
+   installed
+-  Fix yum module not deleting rpms that it downloaded
+-  Fix yum module failing with a URL to an rpm
+-  Fix file module inappropriately expanding literal dollar signs in a
+   path read from the filesystem as an environment variable.
+-  Fix the ssh "smart" transport setting which automatically selects the
+   best means of transferring files over ssh (sftp, ssh, piped).
+-  Fix authentication by api\_key parameter in exoscale modules.
+-  vmware module\_utils shared code ssl/validate\_certs fixes in
+   connection logic
+-  allow 'bridge' facts to work for certain containers that create
+   conflicting ones with connection plugins
+-  Fix for win\_get\_url to use TLS 1.2/1.1 if it is available on the
+   host
+-  Fix for the filetree lookup with non-ascii group names
+-  Better message for invalid keywords/options in task due to undefined
+   expressions
+-  Fixed check mode for enable on Solaris for service module
+-  Fix cloudtrail module to allow AWS profiles other than the default
+-  Fix an encoding issue with secret (password) vars\_prompts
+-  Fix for Windows become to show the stdout and stderr strings on a
+   failure
+-  Fix the issue SSL verification can not be disabled for Tower modules
+-  Use safe\_load instead on load to read a yaml document
+-  Fix for win\_file to respect check mode when deleting directories
+-  Include\_role now complains about invalid arguments
+-  Added socket conditions to ignore for wait\_for, no need to error for
+   closing already closed connection
+-  Updated hostname module to work on newer RHEL7 releases
+-  Security fix to avoid provider password leaking in logs for network
+   modules
+
+ \* Python3 fixes for azure modules
+
+2.3.2 "Ramble On" - 2017-08-04
+------------------------------
+
+Bugfixes
+~~~~~~~~
+
+-  Fix partend i18n issues
+-  fixed handling of extra vars for tower\_job\_template (#25272)
+-  Python3 bugfixes
+-  Fix sorting of ec2 policies
+-  Fix digital\_ocean dynamic inventory script
+-  Fix for the docker connection plugin
+-  Fix pip module when using python3's pyvenv and python3 -m venv to
+   create virtualenvs
+-  Fix for the AnsiBallZ wrapper so that it gives a better error message
+   when there's not enough disk space to create its tempdir.
+-  Fix so ansilbe-galaxy install --force with unversioned roles will
+   once again overwrite old versions.
+-  Fix for RabbitMQ 3.6.7 endpoint return code changing.
+-  Fix for Foreman organization creation
+-  fixed incorrect fail\_json ref in rpm\_key
+-  Corrected requried on hash\_name for dynamodb\_table
+-  Fix for fetch action plugin not validating correctly
+-  Avoid vault view writing display to logs
+-  htpasswd: fix passlib module version comparison
+-  Fix for flowdock error message when external\_user\_name is missing
+-  fixed corner case for delegate\_to, loops and delegate\_facts
+-  fixed wait\_for python2.4/2.5 compatibility (this is last version
+   this is needed)
+-  fix for adhoc not obeying callback options
+-  fix for win\_find where it fails to recursively scan empty nested
+   directories
+-  fix non-pipelined code paths for Windows (eg,
+   ANSIBLE\_KEEP\_REMOTE\_FILES, non-pipelined connection plugins)
+-  fix for win\_updates where args and check mode were ignored due to
+   common code change
+-  fix for unprivileged users to Windows runas become method
+-  fix starttls code path for mail module
+-  fix missing LC\_TYPE in parted module
+-  fix CN parsing with OpenSSL 1.1 in letsencrypt module
+-  fix params assignment in jabber module
+-  fix TXT record type handling in exo\_dns\_record module
+-  fix message queue message ttl can't be 0 in rabbitmq\_queue module
+-  CloudStack bugfixes:
+-  fix template upload for users in cs\_template module, change default
+   to is\_routing=None
+-  several fixes in cs\_host module fixes hypervisor handling
+-  fix network param ignored due typo in cs\_nic module
+-  fix missing type bool in module cs\_zone
+-  fix KeyError: 'sshkeypair' in cs\_instance module for CloudStack v4.5
+   and before
+-  fix for win\_chocolatey where trying to upgrade all the packages as
+   per the example docs fails
+-  fix for win\_chocolatey where it did not fail if the version set did
+   not exist
+-  fix for win\_regedit always changing a reg key if the dword values
+   set is a hex
+-  fix for wait\_for on non-Linux systems with newer versions of psutil
+-  fix eos\_banner code and test issues
+-  run tearup and teardown of EAPI service only on EAPI tests
+-  fix eos\_config tests so only Eth1 and Eth2 are used
+-  Fix for potential bug when using legacy inventory vars for
+   configuring the su password.
+-  Fix crash in file module when directories contain non-utf8 filenames
+-  Fix for dnf groupinstall with dnf-2.x
+-  Fix seboolean module for incompatibility in newer Python3 selinux
+   bindings
+-  Optimization for inventory, no need to dedup at every stage, its
+   redundant and slow
+-  Fix fact gathering for package and service action plugins
+-  make random\_choice more error resilient (#27380)
+-  ensure prefix in plugin loading to avoid conflicts
+-  fix for a small number of modules (tempfile, possibly copy) which
+   could fail if the tempdir on the remote box was a symlink
+-  fix non-pipelined code paths for Windows (eg,
+   ANSIBLE\_KEEP\_REMOTE\_FILES, non-pipelined connection plugins)
+-  fix for win\_updates where args and check mode were ignored due to
+   common code change
+
+2.3.1 "Ramble On" - 2017-06-01
+------------------------------
+
+Bugfixes
+~~~~~~~~
+
+-  Security fix for CVE-2017-7481 - data for lookup plugins used as
+   variables was not being correctly marked as "unsafe".
+-  Fix default value of fetch module's validate\_checksum to be True
+-  Added fix for "meta: refresh\_connection" not working with default
+   'smart' connection.
+-  Fix template so that the --diff command line option works when the
+   destination is a directory
+-  Fix python3 bugs in pam\_limits
+-  Fix unbound error when using module deprecation as a single string
+-  Several places in which error handling was broken due to bad
+   conversions or just typos
+-  Fix to user module for appending/setting groups on OpenBSD (flags
+   were reversed)
+-  assemble fix to use safer os.join.path, avoids charset issues
+-  fixed issue with solaris facts and i18n
+-  added python2.4 compatiblity fix to sysctl module
+-  Fix comparison of exisiting container security opts in the
+   docker\_container module
+-  fixed service module invocation of insserv on certain platforms
+-  Fix traceback in os\_user in an error case.
+-  Fix docker container to restart a container when changing to fewer
+   exposed ports
+-  Fix tracebacks in docker\_network
+-  Fixes to detection of updated docker images
+-  Handle detection of docker image changes when published ports is
+   changed
+-  Fix for docker\_container restarting images when links list is empty.
+
+2.3 "Ramble On" - 2017-04-12
+----------------------------
+
+Moving to Ansible 2.3 guide
+http://docs.ansible.com/ansible/porting\_guide\_2.3.html
+
+Major Changes
+~~~~~~~~~~~~~
+
+-  Documented and renamed the previously released 'single var vaulting'
+   feature, allowing user to use vault encryption for single variables
+   in a normal YAML vars file.
+-  Allow module\_utils for custom modules to be placed in site-specific
+   directories and shipped in roles
+-  On platforms that support it, use more modern system polling API
+   instead of select in the ssh connection plugin. This removes one
+   limitation on how many parallel forks are feasible on these systems.
+-  Windows/WinRM supports (experimental) become method "runas" to run
+   modules and scripts as a different user, and to transparently access
+   network resources.
+-  The WinRM connection plugin now uses pipelining when executing
+   modules, resulting in significantly faster execution for small tasks.
+-  The WinRM connection plugin can now manage Kerberos tickets
+   automatically when ``ansible_winrm_transport=kerberos`` and
+   ``ansible_user``/``ansible_password`` are specified.
+-  Refactored/standardized most Windows modules, adding check-mode and
+   diff support where possible.
+-  Extended Windows module API with parameter-type support, helper
+   functions. (i.e. Expand-Environment, Add-Warning,
+   Add-DeprecatationWarning)
+-  restructured how async works to allow it to apply to action plugins
+   that choose to support it.
+
+Minor Changes
+~~~~~~~~~~~~~
+
+-  The version and release facts for OpenBSD hosts were reversed. This
+   has been changed so that version has the numeric portion and release
+   has the name of the release.
+-  removed 'package' from default squash actions as not all package
+   managers support it and it creates errors when using loops, any user
+   can add back via config options if they don't use those package
+   managers or otherwise avoid the errors.
+-  Blocks can now have a ``name`` field, to aid in playbook readability.
+-  default strategy is now configurable via ansible.cfg or environment
+   variable.
+-  Added 'ansible\_playbook\_python' which contains 'current python
+   executable', it can be blank in some cases in which Ansible is not
+   invoked via the standard CLI (sys.executable limitation).
+-  Added 'metadata' to modules to enable classification
+-  ansible-doc now displays path to module and existing 'metadata'
+-  added optional 'piped' transfer method to ssh plugin for when scp and
+   sftp are missing, ssh plugin is also now 'smarter' when using these
+   options
+-  default controlpersist path is now a custom hash of host-port-user to
+   avoid the socket path length errors for long hostnames
+-  Various fixes for Python3 compatibility
+-  Fixed issues with inventory formats not handling 'all' and
+   'ungrouped' in an uniform way.
+-  'service' tasks can now use async again, we had lost this capability
+   when changed into an action plugin.
+-  made any\_errors\_fatal inheritable from play to task and all other
+   objects in between.
+-  many small performance improvements in inventory and variable
+   handling and in task execution.
+-  Added a retry class to the ec2\_asg module since customers were
+   running into throttling errors (AWSRetry is a solution for modules
+   using boto3 which isn't applicable here).
+
+Deprecations
+~~~~~~~~~~~~
+
+-  Specifying --tags (or --skip-tags) multiple times on the command line
+   currently leads to the last one overriding all the previous ones.
+   This behaviour is deprecated. In the future, if you specify --tags
+   multiple times the tags will be merged together. From now on, using
+   --tags multiple times on one command line will emit a deprecation
+   warning. Setting the merge\_multiple\_cli\_tags option to True in the
+   ansible.cfg file will enable the new behaviour. In 2.4, the default
+   will be to merge and you can enable the old overwriting behaviour via
+   the config option. In 2.5, multiple --tags options will be merged
+   with no way to go back to the old behaviour.
+
+-  Modules (scheduled for removal in 2.5)
+-  ec2\_vpc
+-  cl\_bond
+-  cl\_bridge
+-  cl\_img\_install
+-  cl\_interface
+-  cl\_interface\_policy
+-  cl\_license
+-  cl\_ports
+-  nxos\_mtu, use nxos\_system instead
+
+New: Callbacks
+^^^^^^^^^^^^^^
+
+-  dense: minimal stdout output with fallback to default when verbose
+
+New: lookups
+^^^^^^^^^^^^
+
+-  keyring: allows getting password from the 'controller' system's
+   keyrings
+
+New: cache
+^^^^^^^^^^
+
+-  pickle (uses python's own serializer)
+-  yaml
+
+New: inventory scripts
+^^^^^^^^^^^^^^^^^^^^^^
+
+-  oVirt/RHV
+
+New: filters
+^^^^^^^^^^^^
+
+-  combinations
+-  permutations
+-  zip
+-  zip\_longest
+
+Module Notes
+~~~~~~~~~~~~
+
+-  AWS lambda: previously ignored changes that only affected one
+   parameter. Existing deployments may have outstanding changes that
+   this bugfix will apply.
+-  oVirt/RHV: Added support for 4.1 features and the following:
+-  data centers, clusters, hosts, storage domains and networks
+   management.
+-  hosts and virtual machines affinity groups and labels.
+-  users, groups and permissions management.
+-  Improved virtual machines and disks management.
+-  Mount: Some fixes so bind mounts are not mounted each time the
+   playbook runs.
+
+New Modules
+~~~~~~~~~~~
+
+-  a10\_server\_axapi3
+-  amazon:
+-  aws\_kms
+-  cloudfront\_facts
+-  ec2\_group\_facts
+-  ec2\_lc\_facts
+-  ec2\_vpc\_igw\_facts
+-  ec2\_vpc\_nat\_gateway\_facts
+-  ec2\_vpc\_vgw\_facts
+-  ecs\_ecr
+-  elasticache\_parameter\_group
+-  elasticache\_snapshot
+-  iam\_role
+-  s3\_sync
+-  archive
+-  beadm
+-  bigswitch:
+-  bigmon\_chain
+-  bigmon\_policy
+-  cloudengine:
+-  ce\_command
+-  cloudscale\_server
+-  cloudstack:
+-  cs\_host
+-  cs\_nic
+-  cs\_region
+-  cs\_role
+-  cs\_vpc
+-  dimensiondata\_network
+-  eos:
+-  eos\_banner
+-  eos\_system
+-  eos\_user
+-  f5:
+-  bigip\_gtm\_facts
+-  bigip\_hostname
+-  bigip\_snat\_pool
+-  bigip\_sys\_global
+-  foreman:
+-  foreman
+-  katello
+-  fortios
+-  fortios\_config
+-  gconftool2
+-  google:
+-  gce\_eip
+-  gce\_snapshot
+-  gcpubsub
+-  gcpubsub\_facts
+-  hpilo:
+-  hpilo\_boot
+-  hpilo\_facts
+-  hponcfg
+-  icinga2\_feature
+-  illumos:
+-  dladm\_iptun
+-  dladm\_linkprop
+-  dladm\_vlan
+-  ipadm\_addr
+-  ipadm\_addrprop
+-  ipadm\_ifprop
+-  infinidat:
+-  infini\_export
+-  infini\_export\_client
+-  infini\_fs
+-  infini\_host
+-  infini\_pool
+-  infini\_vol
+-  ipa:
+-  ipa\_group
+-  ipa\_hbacrule
+-  ipa\_host
+-  ipa\_hostgroup
+-  ipa\_role
+-  ipa\_sudocmd
+-  ipa\_sudocmdgroup
+-  ipa\_sudorule
+-  ipa\_user
+-  ipinfoio\_facts
+-  ios:
+-  ios\_banner
+-  ios\_system
+-  ios\_vrf
+-  iosxr\_system
+-  iso\_extract
+-  java\_cert
+-  jenkins\_script
+-  ldap:
+-  ldap\_attr
+-  ldap\_entry
+-  logstash\_plugin
+-  mattermost
+-  net\_command
+-  netapp:
+-  sf\_account\_manager
+-  sf\_snapshot\_schedule\_manager
+-  sf\_volume\_manager
+-  sf\_volume\_access\_group\_manager
+-  nginx\_status\_facts
+-  nsupdate
+-  omapi\_host
+-  openssl:
+-  openssl\_privatekey
+-  openssl\_publickey
+-  openstack:
+-  os\_nova\_host\_aggregate
+-  os\_quota
+-  openwrt\_init
+-  ordnance:
+-  ordnance\_config
+-  ordnance\_facts
+-  ovirt:
+-  ovirt\_affinity\_groups
+-  ovirt\_affinity\_labels
+-  ovirt\_affinity\_labels\_facts
+-  ovirt\_clusters
+-  ovirt\_clusters\_facts
+-  ovirt\_datacenters
+-  ovirt\_datacenters\_facts
+-  ovirt\_external\_providers
+-  ovirt\_external\_providers\_facts
+-  ovirt\_groups
+-  ovirt\_groups\_facts
+-  ovirt\_host\_networks
+-  ovirt\_host\_pm
+-  ovirt\_hosts
+-  ovirt\_hosts\_facts
+-  ovirt\_mac\_pools
+-  ovirt\_networks
+-  ovirt\_networks\_facts
+-  ovirt\_nics
+-  ovirt\_nics\_facts
+-  ovirt\_permissions
+-  ovirt\_permissions\_facts
+-  ovirt\_quotas
+-  ovirt\_quotas\_facts
+-  ovirt\_snapshots
+-  ovirt\_snapshots\_facts
+-  ovirt\_storage\_domains
+-  ovirt\_storage\_domains\_facts
+-  ovirt\_tags
+-  ovirt\_tags\_facts
+-  ovirt\_templates
+-  ovirt\_templates\_facts
+-  ovirt\_users
+-  ovirt\_users\_facts
+-  ovirt\_vmpools
+-  ovirt\_vmpools\_facts
+-  ovirt\_vms\_facts
+-  pacemaker\_cluster
+-  packet:
+-  packet\_device
+-  packet\_sshkey
+-  pamd
+-  panos:
+-  panos\_address
+-  panos\_admin
+-  panos\_admpwd
+-  panos\_cert\_gen\_ssh
+-  panos\_check
+-  panos\_commit
+-  panos\_dag
+-  panos\_import
+-  panos\_interface
+-  panos\_lic
+-  panos\_loadcfg
+-  panos\_mgtconfig
+-  panos\_nat\_policy
+-  panos\_pg
+-  panos\_restart
+-  panos\_security\_policy
+-  panos\_service
+-  postgresql\_schema
+-  proxmox\_kvm
+-  proxysql:
+-  proxysql\_backend\_servers
+-  proxysql\_global\_variables
+-  proxysql\_manage\_config
+-  proxysql\_mysql\_users
+-  proxysql\_query\_rules
+-  proxysql\_replication\_hostgroups
+-  proxysql\_scheduler
+-  pubnub\_blocks
+-  pulp\_repo
+-  runit
+-  serverless
+-  set\_stats
+-  panos:
+-  panos\_security\_policy
+-  smartos:
+-  imgadm
+-  vmadm
+-  sorcery
+-  stacki\_host
+-  swupd
+-  tempfile
+-  tower:
+-  tower\_credential
+-  tower\_group
+-  tower\_host
+-  tower\_inventory
+-  tower\_job\_template
+-  tower\_label
+-  tower\_organization
+-  tower\_project
+-  tower\_role
+-  tower\_team
+-  tower\_user
+-  vmware:
+-  vmware\_guest\_facts
+-  vmware\_guest\_snapshot
+-  web\_infrastructure:
+-  jenkins\_script
+-  system
+-  parted
+-  windows:
+-  win\_disk\_image
+-  win\_dns\_client
+-  win\_domain
+-  win\_domain\_controller
+-  win\_domain\_membership
+-  win\_find
+-  win\_msg
+-  win\_path
+-  win\_psexec
+-  win\_reg\_stat
+-  win\_region
+-  win\_say
+-  win\_shortcut
+-  win\_tempfile
+-  xbps
+-  zfs:
+-  zfs\_facts
+-  zpool\_facts

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/config.yaml

@@ -1,22 +1,18 @@
 ---
-title: ansible-core
 release_tag_re: '(v(?:[\d.ab\-]|rc)+)'
 pre_release_tag_re: '(?P<pre_release>(?:[ab]|rc)+\d*)$'
-changes_file: changelog.yaml
-changes_format: combined
-keep_fragments: true
-always_refresh: true
-ignore_other_fragment_extensions: true
-mention_ancestor: false
 notesdir: fragments
 prelude_section_name: release_summary
-new_plugins_after_name: removed_features
 sections:
 - ['major_changes', 'Major Changes']
 - ['minor_changes', 'Minor Changes']
-- ['breaking_changes', 'Breaking Changes / Porting Guide']
 - ['deprecated_features', 'Deprecated Features']
 - ['removed_features', 'Removed Features (previously deprecated)']
-- ['security_fixes', 'Security Fixes']
+- ['new_lookup_plugins', 'New Lookup Plugins']
+- ['new_callback_plugins', 'New Callback Plugins']
+- ['new_connection_plugins', 'New Connection Plugins']
+- ['new_test_plugins', 'New Test Plugins']
+- ['new_filter_plugins', 'New Filter Plugins']
+- ['new_modules', 'New Modules']
 - ['bugfixes', 'Bugfixes']
 - ['known_issues', 'Known Issues']

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/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/30786-verbose_info_on_os_stack_error.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- openstack.os_stack - extend failure message with the server response (https://github.com/ansible/ansible/pull/39660).

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/36980-eos_check_mode_without_config_session.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- EOS can not check configuration without use of config session (ANSIBLE_EOS_USE_SESSIONS=0). Fix is to throw error when hiting into this exception case. Configs would neither be checked nor be played on the eos device.

changelogs/fragments/37056-vmware_guest_no_permission.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- Adds exception handling which is raised when user does not have correct set of permissions/privileges to read virtual machine facts.

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/37651-onxy_pfc_interface-onyx-version-3.6.0.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- onyx_pfc_interface - Add support for changes in pfc output in onyx 3.6.6000 https://github.com/ansible/ansible/pull/37651

changelogs/fragments/38167-onxy_linkagg-add-support-for-onyx-version-3.6.0.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- Fix mlag summary json parsing for onyx version 3.6.6000 and above https://github.com/ansible/ansible/pull/38191

changelogs/fragments/38290-doc_update_vmware_guest_find.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- Update documentation related to datacenter in vmware_guest_find module. Mark datacenter as optional.

changelogs/fragments/38398-vmware_guest_typecast_vlan.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- vmware_guest - typecast VLAN ID to match various conditions. (https://github.com/ansible/ansible/pull/39793)

changelogs/fragments/38466-vmware_guest_set_dhcp_as_default.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- Set default network type as 'dhcp' if user has not specified any.

changelogs/fragments/38654-update_vmware_cfg_backup_variable_usage.yml

@@ -0,0 +1,2 @@
+bugfixes:
+- Changed hostname variable in order for the esxi host to be found when authentication against a vcenter was done.

changelogs/fragments/38671-nmcli_autoconnect_value_correction.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- nmcli change default value of autoconnect

changelogs/fragments/38941-vmware_guest_update_cpu_memory_if_required.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- vmware_guest - Do not update cpu/memory allocation in configspec if there is no change (https://github.com/ansible/ansible/pull/39865)

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/39138-facts-fix_virtualization_facts_for_vmware_linux.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- Fix unset 'ansible_virtualization_role' fact while setting virtualization facts for real hardware.

changelogs/fragments/39818-loop_control_task_vars.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+  - loop_control - update template vars for loop_control fields on each loop iteration (https://github.com/ansible/ansible/pull/39818).

changelogs/fragments/40600-apt-mark-availability.yml

@@ -0,0 +1,2 @@
+bugfixes:
+- skip marking packages as manually installed when apt-mark is not available (https://github.com/ansible/ansible/pull/40600)

changelogs/fragments/40645-jenkins_plugin.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- jenkins_plugin - fix plugin always updated even if already uptodate (https://github.com/ansible/ansible/pull/40645)

changelogs/fragments/41530-apt-mark-deb6.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+  - apt - fix apt-mark on debian6 (https://github.com/ansible/ansible/pull/41530)

changelogs/fragments/43931-strip-trailing-comments.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - user - Strip trailing comments in /etc/default/passwd (https://github.com/ansible/ansible/pull/43931)

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/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``)

changelogs/fragments/70028-config-small-typo-fix.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - config - use ``callbacks_enabled`` instead ``callback_enabled`` in a deprecated message (https://github.com/ansible/ansible/issues/70028).

changelogs/fragments/70792-yum-action-plugin-use-as-alias-of-use-backend.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - yum - yum action plugin changes to support 'use' as an alias of 'use_backend' (https://github.com/ansible/ansible/issues/70774).

changelogs/fragments/70949-yum-parsing-check-update-output-multiple-empty-lines.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - yum - fix parsing of multiple subsequent empty lines from ``yum check-update`` output (https://github.com/ansible/ansible/issues/70949)

changelogs/fragments/71343_yum_repository.yml

@@ -1,2 +0,0 @@
-bugfixes:
-- basic - skip over module parameters which are used in ``journal.send`` API call (https://github.com/ansible/ansible/issues/71343).

changelogs/fragments/72607.yml

@@ -1,2 +0,0 @@
-minor_changes:
-- YAML parsing - Create common utils for loading and dumping YAML that prefer the C extensions if available

changelogs/fragments/72651-dnf-capture-transaction-failure.yml

@@ -1,2 +0,0 @@
-bugfixes:
-  - dnf - properly capture transaction error (https://github.com/ansible/ansible/issues/72651)