Release 10.4.0.

Allow Xen Host and/or Xen VM names instead of their UUIDs (#9787)

* Allow using Xen Host and/or Xen VM names instead of their UUIDs for inventory

* xen_orchestra inventory plugin allow using vm and host names instead of UUID inventory

* Update changelog fragment with correct PR number

* Set missing inventory attributes in unit test

* Add version_added suggestion as per github comments

* Description update.

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit e8e3e5c2b0)

Co-authored-by: rt-vnx <riordan.toms@vonex.com.au>

.azure-pipelines/azure-pipelines.yml

@@ -29,13 +29,14 @@ schedules:
     always: true
     branches:
       include:
-        - stable-11
+        - stable-10
+        - stable-9
   - cron: 0 11 * * 0
     displayName: Weekly (old stable branches)
     always: true
     branches:
       include:
-        - stable-10
+        - stable-8
 
 variables:
   - name: checkoutPath
@@ -50,7 +51,7 @@ variables:
 resources:
   containers:
     - container: default
-      image: quay.io/ansible/azure-pipelines-test-container:7.0.0
+      image: quay.io/ansible/azure-pipelines-test-container:6.0.0
 
 pool: Standard
 
@@ -69,32 +70,7 @@ stages:
             - test: 2
             - test: 3
             - test: 4
-  - stage: Sanity_2_20
-    displayName: Sanity 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.20/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-  - stage: Sanity_2_19
-    displayName: Sanity 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.19/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
+            - test: extra
   - stage: Sanity_2_18
     displayName: Sanity 2.18
     dependsOn: []
@@ -108,6 +84,32 @@ stages:
             - test: 2
             - test: 3
             - test: 4
+  - stage: Sanity_2_17
+    displayName: Sanity 2.17
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.17/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
+  - stage: Sanity_2_16
+    displayName: Sanity 2.16
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.16/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
 ### Units
   - stage: Units_devel
     displayName: Units devel
@@ -118,36 +120,12 @@ stages:
           nameFormat: Python {0}
           testFormat: devel/units/{0}/1
           targets:
+            - test: 3.8
             - test: 3.9
             - test: '3.10'
             - test: '3.11'
             - test: '3.12'
             - test: '3.13'
-            - test: '3.14'
-  - stage: Units_2_20
-    displayName: Units 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.20/units/{0}/1
-          targets:
-            - test: 3.9
-            - test: "3.12"
-            - test: "3.14"
-  - stage: Units_2_19
-    displayName: Units 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.19/units/{0}/1
-          targets:
-            - test: 3.8
-            - test: "3.11"
-            - test: "3.13"
   - stage: Units_2_18
     displayName: Units 2.18
     dependsOn: []
@@ -158,8 +136,30 @@ stages:
           testFormat: 2.18/units/{0}/1
           targets:
             - test: 3.8
-            - test: "3.11"
             - test: "3.13"
+  - stage: Units_2_17
+    displayName: Units 2.17
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.17/units/{0}/1
+          targets:
+            - test: 3.7
+            - test: "3.12"
+  - stage: Units_2_16
+    displayName: Units 2.16
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.16/units/{0}/1
+          targets:
+            - test: 2.7
+            - test: 3.6
+            - test: "3.11"
 
 ## Remote
   - stage: Remote_devel_extra_vms
@@ -170,10 +170,10 @@ stages:
         parameters:
           testFormat: devel/{0}
           targets:
-            - name: Alpine 3.22
-              test: alpine/3.22
-            # - name: Fedora 42
-            #   test: fedora/42
+            - name: Alpine 3.21
+              test: alpine/3.21
+            # - name: Fedora 41
+            #   test: fedora/41
             - name: Ubuntu 22.04
               test: ubuntu/22.04
             - name: Ubuntu 24.04
@@ -188,50 +188,14 @@ stages:
         parameters:
           testFormat: devel/{0}
           targets:
-            - name: macOS 15.3
-              test: macos/15.3
-            - name: RHEL 10.0
-              test: rhel/10.0
-            - name: RHEL 9.6
-              test: rhel/9.6
-            - name: FreeBSD 14.3
-              test: freebsd/14.3
-            - name: FreeBSD 13.5
-              test: freebsd/13.5
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_20
-    displayName: Remote 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.20/{0}
-          targets:
-            - name: RHEL 10.0
-              test: rhel/10.0
-            - name: FreeBSD 14.3
-              test: freebsd/14.3
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_19
-    displayName: Remote 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/{0}
-          targets:
+            - name: macOS 14.3
+              test: macos/14.3
             - name: RHEL 9.5
               test: rhel/9.5
-            - name: RHEL 10.0
-              test: rhel/10.0
             - name: FreeBSD 14.2
               test: freebsd/14.2
+            - name: FreeBSD 13.4
+              test: freebsd/13.4
           groups:
             - 1
             - 2
@@ -244,8 +208,6 @@ stages:
         parameters:
           testFormat: 2.18/{0}
           targets:
-            - name: macOS 14.3
-              test: macos/14.3
             - name: RHEL 9.4
               test: rhel/9.4
             - name: FreeBSD 14.1
@@ -254,6 +216,46 @@ stages:
             - 1
             - 2
             - 3
+  - stage: Remote_2_17
+    displayName: Remote 2.17
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.17/{0}
+          targets:
+            - name: FreeBSD 13.3
+              test: freebsd/13.3
+            - name: RHEL 9.3
+              test: rhel/9.3
+            - name: FreeBSD 14.0
+              test: freebsd/14.0
+          groups:
+            - 1
+            - 2
+            - 3
+  - stage: Remote_2_16
+    displayName: Remote 2.16
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.16/{0}
+          targets:
+            - name: macOS 13.2
+              test: macos/13.2
+            - name: RHEL 9.2
+              test: rhel/9.2
+            - name: RHEL 8.8
+              test: rhel/8.8
+            - name: RHEL 7.9
+              test: rhel/7.9
+            # - name: FreeBSD 13.2
+            #   test: freebsd/13.2
+          groups:
+            - 1
+            - 2
+            - 3
 
 ### Docker
   - stage: Docker_devel
@@ -263,47 +265,15 @@ stages:
       - template: templates/matrix.yml
         parameters:
           testFormat: devel/linux/{0}
-          targets:
-            - name: Fedora 42
-              test: fedora42
-            - name: Alpine 3.22
-              test: alpine322
-            - name: Ubuntu 22.04
-              test: ubuntu2204
-            - name: Ubuntu 24.04
-              test: ubuntu2404
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_20
-    displayName: Docker 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.20/linux/{0}
-          targets:
-            - name: Fedora 42
-              test: fedora42
-            - name: Alpine 3.22
-              test: alpine322
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_19
-    displayName: Docker 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/linux/{0}
           targets:
             - name: Fedora 41
               test: fedora41
             - name: Alpine 3.21
               test: alpine321
+            - name: Ubuntu 22.04
+              test: ubuntu2204
+            - name: Ubuntu 24.04
+              test: ubuntu2404
           groups:
             - 1
             - 2
@@ -326,6 +296,44 @@ stages:
             - 1
             - 2
             - 3
+  - stage: Docker_2_17
+    displayName: Docker 2.17
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.17/linux/{0}
+          targets:
+            - name: Fedora 39
+              test: fedora39
+            - name: Alpine 3.19
+              test: alpine319
+            - name: Ubuntu 20.04
+              test: ubuntu2004
+          groups:
+            - 1
+            - 2
+            - 3
+  - stage: Docker_2_16
+    displayName: Docker 2.16
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.16/linux/{0}
+          targets:
+            - name: Fedora 38
+              test: fedora38
+            - name: openSUSE 15
+              test: opensuse15
+            - name: Alpine 3
+              test: alpine3
+            - name: CentOS 7
+              test: centos7
+          groups:
+            - 1
+            - 2
+            - 3
 
 ### Community Docker
   - stage: Docker_community_devel
@@ -336,12 +344,10 @@ stages:
         parameters:
           testFormat: devel/linux-community/{0}
           targets:
-            - name: Debian 11 Bullseye
+            - name: Debian Bullseye
               test: debian-bullseye/3.9
-            - name: Debian 12 Bookworm
+            - name: Debian Bookworm
               test: debian-bookworm/3.11
-            - name: Debian 13 Trixie
-              test: debian-13-trixie/3.13
             - name: ArchLinux
               test: archlinux/3.13
           groups:
@@ -360,30 +366,8 @@ stages:
 #          nameFormat: Python {0}
 #          testFormat: devel/generic/{0}/1
 #          targets:
-#            - test: '3.9'
-#            - test: '3.12'
-#            - test: '3.14'
-#  - stage: Generic_2_20
-#    displayName: Generic 2.20
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.20/generic/{0}/1
-#          targets:
-#            - test: '3.10'
-#            - test: '3.14'
-#  - stage: Generic_2_19
-#    displayName: Generic 2.19
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.19/generic/{0}/1
-#          targets:
-#            - test: '3.9'
+#            - test: '3.8'
+#            - test: '3.11'
 #            - test: '3.13'
 #  - stage: Generic_2_18
 #    displayName: Generic 2.18
@@ -396,32 +380,55 @@ stages:
 #          targets:
 #            - test: '3.8'
 #            - test: '3.13'
+#  - stage: Generic_2_17
+#    displayName: Generic 2.17
+#    dependsOn: []
+#    jobs:
+#      - template: templates/matrix.yml
+#        parameters:
+#          nameFormat: Python {0}
+#          testFormat: 2.17/generic/{0}/1
+#          targets:
+#            - test: '3.7'
+#            - test: '3.12'
+#  - stage: Generic_2_16
+#    displayName: Generic 2.16
+#    dependsOn: []
+#    jobs:
+#      - template: templates/matrix.yml
+#        parameters:
+#          nameFormat: Python {0}
+#          testFormat: 2.16/generic/{0}/1
+#          targets:
+#            - test: '2.7'
+#            - test: '3.6'
+#            - test: '3.11'
 
   - stage: Summary
     condition: succeededOrFailed()
     dependsOn:
       - Sanity_devel
-      - Sanity_2_20
-      - Sanity_2_19
       - Sanity_2_18
+      - Sanity_2_17
+      - Sanity_2_16
       - Units_devel
-      - Units_2_20
-      - Units_2_19
       - Units_2_18
+      - Units_2_17
+      - Units_2_16
       - Remote_devel_extra_vms
       - Remote_devel
-      - Remote_2_20
-      - Remote_2_19
       - Remote_2_18
+      - Remote_2_17
+      - Remote_2_16
       - Docker_devel
-      - Docker_2_20
-      - Docker_2_19
       - Docker_2_18
+      - Docker_2_17
+      - Docker_2_16
       - Docker_community_devel
 # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
 #      - Generic_devel
-#      - Generic_2_20
-#      - Generic_2_19
 #      - Generic_2_18
+#      - Generic_2_17
+#      - Generic_2_16
     jobs:
       - template: templates/coverage.yml

.azure-pipelines/templates/matrix.yml

@@ -50,11 +50,11 @@ jobs:
     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)) }}
+          - ${{ 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) }}
+          - ${{ 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

@@ -14,37 +14,37 @@ parameters:
 
 jobs:
   - ${{ each job in parameters.jobs }}:
-      - job: test_${{ 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)"
+    - job: test_${{ 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)"

.git-blame-ignore-revs

@@ -1,12 +0,0 @@
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# YAML reformatting
-d032de3b16eed11ea3a31cd3d96d78f7c46a2ee0
-e8f965fbf8154ea177c6622da149f2ae8533bd3c
-e938ca5f20651abc160ee6aba10014013d04dcc1
-eaa5e07b2866e05b6c7b5628ca92e9cb1142d008
-
-# Code reformatting
-340ff8586d4f1cb6a0f3c934eb42589bcc29c0ea

.github/BOTMETA.yml

@@ -77,8 +77,6 @@ files:
   $callbacks/opentelemetry.py:
     keywords: opentelemetry observability
     maintainers: v1v
-  $callbacks/print_task.py:
-    maintainers: demonpig
   $callbacks/say.py:
     keywords: brew cask darwin homebrew macosx macports osx
     labels: macos say
@@ -92,13 +90,12 @@ files:
     maintainers: ryancurrah
   $callbacks/syslog_json.py:
     maintainers: imjoseangel
-  $callbacks/tasks_only.py:
-    maintainers: felixfontein
   $callbacks/timestamp.py:
     maintainers: kurokobo
   $callbacks/unixy.py:
     labels: unixy
     maintainers: akatch
+  $callbacks/yaml.py: {}
   $connections/:
     labels: connections
   $connections/chroot.py: {}
@@ -114,17 +111,20 @@ files:
   $connections/lxd.py:
     labels: lxd
     maintainers: mattclay
+  $connections/proxmox_pct_remote.py:
+    labels: proxmox
+    maintainers: mietzen
   $connections/qubes.py:
     maintainers: kushaldas
   $connections/saltstack.py:
     labels: saltstack
     maintainers: mscherer
-  $connections/wsl.py:
-    maintainers: rgl
   $connections/zone.py:
     maintainers: $team_ansible_core
   $doc_fragments/:
     labels: docs_fragments
+  $doc_fragments/clc.py:
+    maintainers: clc-runner russoz
   $doc_fragments/django.py:
     maintainers: russoz
   $doc_fragments/hpe3par.py:
@@ -208,20 +208,12 @@ files:
     maintainers: resmo
   $filters/to_months.yml:
     maintainers: resmo
-  $filters/to_nice_yaml.yml:
-    maintainers: felixfontein
-  $filters/to_prettytable.py:
-    maintainers: tgadiev
   $filters/to_seconds.yml:
     maintainers: resmo
   $filters/to_time_unit.yml:
     maintainers: resmo
   $filters/to_weeks.yml:
     maintainers: resmo
-  $filters/to_yaml.py:
-    maintainers: felixfontein
-  $filters/to_yaml.yml:
-    maintainers: felixfontein
   $filters/to_years.yml:
     maintainers: resmo
   $filters/unicode_normalize.py:
@@ -238,9 +230,6 @@ files:
     maintainers: vbotka
   $inventories/icinga2.py:
     maintainers: BongoEADGC6
-  $inventories/incus.py:
-    labels: incus
-    maintainers: stgraber
   $inventories/linode.py:
     keywords: linode dynamic inventory script
     labels: cloud linode
@@ -254,16 +243,18 @@ files:
     keywords: opennebula dynamic inventory script
     labels: cloud opennebula
     maintainers: feldsam
+  $inventories/proxmox.py:
+    maintainers: $team_virt ilijamt krauthosting
   $inventories/scaleway.py:
     labels: cloud scaleway
     maintainers: $team_scaleway
+  $inventories/stackpath_compute.py:
+    maintainers: shayrybak
   $inventories/virtualbox.py: {}
   $inventories/xen_orchestra.py:
     maintainers: ddelnano shinuza
   $lookups/:
     labels: lookups
-  $lookups/binary_file.py:
-    maintainers: felixfontein
   $lookups/bitwarden_secrets_manager.py:
     maintainers: jantari
   $lookups/bitwarden.py:
@@ -295,13 +286,16 @@ files:
     maintainers: dagwieers
   $lookups/flattened.py: {}
   $lookups/github_app_access_token.py:
-    maintainers: weisheng-p blavoie
+    maintainers: weisheng-p
   $lookups/hiera.py:
     maintainers: jparrill
   $lookups/keyring.py: {}
   $lookups/lastpass.py: {}
   $lookups/lmdb_kv.py:
     maintainers: jpmens
+  $lookups/manifold.py:
+    labels: manifold
+    maintainers: galanoff
   $lookups/merge_variables.py:
     maintainers: rlenferink m-a-r-k-e alpex8
   $lookups/onepass:
@@ -384,18 +378,17 @@ files:
   $module_utils/oracle/oci_utils.py:
     labels: cloud
     maintainers: $team_oracle
-  $module_utils/pacemaker.py:
-    maintainers: munchtoast
   $module_utils/pipx.py:
     labels: pipx
     maintainers: russoz
-  $module_utils/pkg_req.py:
-    maintainers: russoz
   $module_utils/python_runner.py:
     maintainers: russoz
   $module_utils/puppet.py:
     labels: puppet
     maintainers: russoz
+  $module_utils/pure.py:
+    labels: pure pure_storage
+    maintainers: $team_purestorage
   $module_utils/redfish_utils.py:
     labels: redfish_utils
     maintainers: $team_redfish
@@ -409,8 +402,6 @@ files:
     maintainers: russoz
   $module_utils/ssh.py:
     maintainers: russoz
-  $module_utils/systemd.py:
-    maintainers: NomakCooper
   $module_utils/storage/hpe3par/hpe3par.py:
     maintainers: farhan7500 gautamphegde
   $module_utils/utm_utils.py:
@@ -422,8 +413,6 @@ files:
   $module_utils/wdc_redfish_utils.py:
     labels: wdc_redfish_utils
     maintainers: $team_wdc
-  $module_utils/xdg_mime.py:
-    maintainers: mhalano
   $module_utils/xenserver.py:
     labels: xenserver
     maintainers: bvitnik
@@ -479,6 +468,8 @@ files:
     keywords: beadm dladm illumos ipadm nexenta omnios openindiana pfexec smartos solaris sunos zfs zpool
     labels: beadm solaris
     maintainers: $team_solaris
+  $modules/bearychat.py:
+    maintainers: tonyseek
   $modules/bigpanda.py:
     ignore: hkariti
   $modules/bitbucket_:
@@ -505,6 +496,8 @@ files:
     maintainers: NickatEpic
   $modules/cisco_webex.py:
     maintainers: drew-russell
+  $modules/clc_:
+    maintainers: clc-runner
   $modules/cloud_init_data_facts.py:
     maintainers: resmo
   $modules/cloudflare_dns.py:
@@ -553,10 +546,6 @@ files:
     maintainers: russoz
   $modules/django_createcachetable.py:
     maintainers: russoz
-  $modules/django_dumpdata.py:
-    maintainers: russoz
-  $modules/django_loaddata.py:
-    maintainers: russoz
   $modules/django_manage.py:
     ignore: scottanderson42 tastychutney
     labels: django_manage
@@ -584,6 +573,9 @@ files:
   $modules/etcd3.py:
     ignore: vfauth
     maintainers: evrardjp
+  $modules/facter.py:
+    labels: facter
+    maintainers: $team_ansible_core gamethis
   $modules/facter_facts.py:
     labels: facter
     maintainers: russoz $team_ansible_core gamethis
@@ -592,8 +584,6 @@ files:
   $modules/filesystem.py:
     labels: filesystem
     maintainers: pilou- abulimov quidame
-  $modules/file_remove.py:
-    maintainers: shahargolshani
   $modules/flatpak.py:
     maintainers: $team_flatpak
   $modules/flatpak_remote.py:
@@ -666,6 +656,8 @@ files:
     maintainers: marns93
   $modules/hg.py:
     maintainers: yeukhon
+  $modules/hipchat.py:
+    maintainers: pb8226 shirou
   $modules/homebrew.py:
     ignore: ryansb
     keywords: brew cask darwin homebrew macosx macports osx
@@ -791,8 +783,6 @@ files:
     maintainers: brettmilford unnecessary-username juanmcasanova
   $modules/jenkins_build_info.py:
     maintainers: juanmcasanova
-  $modules/jenkins_credential.py:
-    maintainers: YoussefKhalidAli
   $modules/jenkins_job.py:
     maintainers: sermilrod
   $modules/jenkins_job_info.py:
@@ -809,8 +799,6 @@ files:
     maintainers: Slezhuk pertoft
   $modules/kdeconfig.py:
     maintainers: smeso
-  $modules/kea_command.py:
-    maintainers: mirabilos
   $modules/kernel_blacklist.py:
     maintainers: matze
   $modules/keycloak_:
@@ -865,8 +853,6 @@ files:
     maintainers: bratwurzt
   $modules/keycloak_realm_rolemapping.py:
     maintainers: agross mhuysamen Gaetan2907
-  $modules/keycloak_user_execute_actions_email.py:
-    maintainers: mariusbertram
   $modules/keyring.py:
     maintainers: ahussey-redhat
   $modules/keyring_info.py:
@@ -913,10 +899,6 @@ files:
     maintainers: nerzhul
   $modules/lvg.py:
     maintainers: abulimov
-  $modules/lvm_pv.py:
-    maintainers: klention
-  $modules/lvm_pv_move_data.py:
-    maintainers: klention
   $modules/lvg_rename.py:
     maintainers: lszomor
   $modules/lvol.py:
@@ -931,10 +913,6 @@ files:
     maintainers: conloos
   $modules/lxd_project.py:
     maintainers: we10710aa
-  $modules/lxd_storage_pool_info.py:
-    maintainers: smcavoy
-  $modules/lxd_storage_volume_info.py:
-    maintainers: smcavoy
   $modules/macports.py:
     ignore: ryansb
     keywords: brew cask darwin homebrew macosx macports osx
@@ -1075,13 +1053,7 @@ files:
   $modules/ovh_monthly_billing.py:
     maintainers: fraff
   $modules/pacemaker_cluster.py:
-    maintainers: matbu munchtoast
-  $modules/pacemaker_info.py:
-    maintainers: munchtoast
-  $modules/pacemaker_resource.py:
-    maintainers: munchtoast
-  $modules/pacemaker_stonith.py:
-    maintainers: munchtoast
+    maintainers: matbu
   $modules/packet_:
     maintainers: nurfet-becirevic t0mk
   $modules/packet_device.py:
@@ -1157,6 +1129,36 @@ files:
     maintainers: $team_bsd berenddeboer
   $modules/pritunl_:
     maintainers: Lowess
+  $modules/profitbricks:
+    maintainers: baldwinSPC
+  $modules/proxmox:
+    keywords: kvm libvirt proxmox qemu
+    labels: proxmox virt
+    maintainers: $team_virt UnderGreen krauthosting
+    ignore: tleguern
+  $modules/proxmox.py:
+    ignore: skvidal
+    maintainers: UnderGreen krauthosting
+  $modules/proxmox_disk.py:
+    maintainers: castorsky krauthosting
+  $modules/proxmox_kvm.py:
+    ignore: skvidal
+    maintainers: helldorado krauthosting
+  $modules/proxmox_backup.py:
+    maintainers: IamLunchbox
+  $modules/proxmox_backup_info.py:
+    maintainers: raoufnezhad mmayabi
+  $modules/proxmox_nic.py:
+    maintainers: Kogelvis krauthosting
+  $modules/proxmox_node_info.py:
+    maintainers: jwbernin krauthosting
+  $modules/proxmox_storage_contents_info.py:
+    maintainers: l00ptr krauthosting
+  $modules/proxmox_tasks_info:
+    maintainers: paginabianca krauthosting
+  $modules/proxmox_template.py:
+    ignore: skvidal
+    maintainers: UnderGreen krauthosting
   $modules/pubnub_blocks.py:
     maintainers: parfeon pubnub
   $modules/pulp_repo.py:
@@ -1227,9 +1229,9 @@ files:
   $modules/scaleway_compute_private_network.py:
     maintainers: pastral
   $modules/scaleway_container.py:
-    maintainers: Lunik
+     maintainers: Lunik
   $modules/scaleway_container_info.py:
-    maintainers: Lunik
+     maintainers: Lunik
   $modules/scaleway_container_namespace.py:
     maintainers: Lunik
   $modules/scaleway_container_namespace_info.py:
@@ -1437,8 +1439,6 @@ files:
     maintainers: dinoocch the-maldridge
   $modules/xcc_:
     maintainers: panyy3 renxulei
-  $modules/xdg_mime.py:
-    maintainers: mhalano
   $modules/xenserver_:
     maintainers: bvitnik
   $modules/xenserver_facts.py:
@@ -1471,8 +1471,6 @@ files:
     maintainers: natefoo
   $modules/znode.py:
     maintainers: treyperry
-  $modules/zpool.py:
-    maintainers: tomhesse
   $modules/zpool_facts:
     keywords: beadm dladm illumos ipadm nexenta omnios openindiana pfexec smartos solaris sunos zfs zpool
     labels: solaris
@@ -1539,22 +1537,6 @@ files:
     maintainers: russoz
   docs/docsite/rst/guide_deps.rst:
     maintainers: russoz
-  docs/docsite/rst/guide_iocage.rst:
-    maintainers: russoz felixfontein
-  docs/docsite/rst/guide_iocage_inventory.rst:
-    maintainers: vbotka
-  docs/docsite/rst/guide_iocage_inventory_aliases.rst:
-    maintainers: vbotka
-  docs/docsite/rst/guide_iocage_inventory_basics.rst:
-    maintainers: vbotka
-  docs/docsite/rst/guide_iocage_inventory_dhcp.rst:
-    maintainers: vbotka
-  docs/docsite/rst/guide_iocage_inventory_hooks.rst:
-    maintainers: vbotka
-  docs/docsite/rst/guide_iocage_inventory_properties.rst:
-    maintainers: vbotka
-  docs/docsite/rst/guide_iocage_inventory_tags.rst:
-    maintainers: vbotka
   docs/docsite/rst/guide_modulehelper.rst:
     maintainers: russoz
   docs/docsite/rst/guide_online.rst:
@@ -1614,6 +1596,7 @@ macros:
   team_networking: NilashishC Qalthos danielmellado ganeshrn justjais trishnaguha sganesh-infoblox privateip
   team_opennebula: ilicmilan meerkampdvv rsmontero xorel nilsding
   team_oracle: manojmeda mross22 nalsaber
+  team_purestorage: bannaych dnix101 genegr lionmax opslounge raekins sdodsley sile16
   team_redfish: mraineri tomasg2012 xmadsen renxulei rajeevkallur bhavya06 jyundt
   team_rhsm: cnsnyder ptoscano
   team_scaleway: remyleone abarbare

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -7,147 +7,147 @@ name: Bug report
 description: Create a report to help us improve
 
 body:
-  - type: markdown
-    attributes:
-      value: |
-        ⚠
-        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.
-        *Complete **all** sections as described, this form is processed automatically.*
+- type: markdown
+  attributes:
+    value: |
+      ⚠
+      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.
+      *Complete **all** sections as described, this form is processed automatically.*
 
-        [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
+      [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
 
 
-  - type: textarea
-    attributes:
-      label: Summary
-      description: Explain the problem briefly below.
-      placeholder: >-
-        When I try to do X with the collection from the main branch on GitHub, Y
-        breaks in a way Z under the env E. Here are all the details I know
-        about this problem...
-    validations:
+- type: textarea
+  attributes:
+    label: Summary
+    description: Explain the problem briefly below.
+    placeholder: >-
+      When I try to do X with the collection from the main 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
+    # FIXME: Once GitHub allows defining the default choice, update this
+    options:
+    - Bug Report
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    # For smaller collections we could use a multi-select and hardcode the list
+    # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins
+    # Select from list, filter as you type (`mysql` would only show the 3 mysql components)
+    # OR freeform - doesn't seem to be supported in adaptivecards
+    label: Component Name
+    description: >-
+      Write the short name of the module, plugin, task or feature below,
+      *use your best guess if unsure*. Do not include `community.general.`!
+    placeholder: dnf, apt, yum, pip, user etc.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Ansible Version
+    description: >-
+      Paste verbatim output from `ansible --version` between
+      tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible --version
+
+      ```
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Community.general Version
+    description: >-
+      Paste verbatim output from "ansible-galaxy collection list community.general"
+      between tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible-galaxy collection list community.general
+
+      ```
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Configuration
+    description: >-
+      If this issue has an example piece of YAML that can help to reproduce this problem, please provide it.
+      This can be a piece of YAML from, e.g., an automation, script, scene or configuration.
+      Paste verbatim output from `ansible-config dump --only-changed` between quotes
+    value: |
+      ```console (paste below)
+      $ ansible-config dump --only-changed
+
+      ```
+
+
+- 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: false
+
+
+- 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 passed 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)
+
+      ```
+  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.
+      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 between quotes.
+    value: |
+      ```console (paste below)
+
+      ```
+- type: checkboxes
+  attributes:
+    label: Code of Conduct
+    description: |
+      Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
+    options:
+    - label: I agree to follow the Ansible Code of Conduct
       required: true
-
-  - type: dropdown
-    attributes:
-      label: Issue Type
-      # FIXME: Once GitHub allows defining the default choice, update this
-      options:
-        - Bug Report
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      # For smaller collections we could use a multi-select and hardcode the list
-      # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins
-      # Select from list, filter as you type (`mysql` would only show the 3 mysql components)
-      # OR freeform - doesn't seem to be supported in adaptivecards
-      label: Component Name
-      description: >-
-        Write the short name of the module, plugin, task or feature below,
-        *use your best guess if unsure*. Do not include `community.general.`!
-      placeholder: dnf, apt, yum, pip, user etc.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Ansible Version
-      description: >-
-        Paste verbatim output from `ansible --version` between
-        tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible --version
-
-        ```
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Community.general Version
-      description: >-
-        Paste verbatim output from "ansible-galaxy collection list community.general"
-        between tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible-galaxy collection list community.general
-
-        ```
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Configuration
-      description: >-
-        If this issue has an example piece of YAML that can help to reproduce this problem, please provide it.
-        This can be a piece of YAML from, e.g., an automation, script, scene or configuration.
-        Paste verbatim output from `ansible-config dump --only-changed` between quotes
-      value: |
-        ```console (paste below)
-        $ ansible-config dump --only-changed
-
-        ```
-
-
-  - 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: false
-
-
-  - 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 passed 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)
-
-        ```
-    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.
-        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 between quotes.
-      value: |
-        ```console (paste below)
-
-        ```
-  - type: checkboxes
-    attributes:
-      label: Code of Conduct
-      description: |
-        Read the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
-      options:
-        - label: I agree to follow the Ansible Code of Conduct
-          required: true
 ...

.github/ISSUE_TEMPLATE/config.yml

@@ -6,26 +6,26 @@
 # 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/projects/ansible-core/devel/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
-    about: |
-      Please learn how to report security vulnerabilities here.
+- name: Security bug report
+  url: https://docs.ansible.com/ansible-core/devel/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
+  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 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/projects/ansible/latest/community/reporting_bugs_and_features.html
-  - name: Ansible Code of Conduct
-    url: https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
-    about: Be nice to other members of the community.
-  - name: Talks to the community
-    url: https://docs.ansible.com/projects/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_ansible_collections
-    about: Red Hat offers support for the Ansible Automation Platform
+    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_ansible_collections
+  about: Be nice to other members of the community.
+- 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_ansible_collections
+  about: Red Hat offers support for the Ansible Automation Platform

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -8,122 +8,122 @@ description: Ask us about docs
 # NOTE: issue body is enabled to allow screenshots
 
 body:
-  - type: markdown
-    attributes:
-      value: |
-        ⚠
-        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.
-        *Complete **all** sections as described, this form is processed automatically.*
+- type: markdown
+  attributes:
+    value: |
+      ⚠
+      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.
+      *Complete **all** sections as described, this form is processed automatically.*
 
-        [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
+      [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
 
 
-  - type: textarea
-    attributes:
-      label: Summary
-      description: |
-        Explain the problem briefly below, add suggestions to wording or structure.
+- type: textarea
+  attributes:
+    label: Summary
+    description: |
+      Explain the problem briefly below, add suggestions to wording or structure.
 
-        **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page?
-      placeholder: >-
-        I was reading the Collection documentation of version X and I'm having
-        problems understanding Y. It would be very helpful if that got
-        rephrased as Z.
-    validations:
+      **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page?
+    placeholder: >-
+      I was reading the Collection 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
+    # 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 file, module, plugin, task or feature below,
+      *use your best guess if unsure*. Do not include `community.general.`!
+    placeholder: mysql_user
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Ansible Version
+    description: >-
+      Paste verbatim output from `ansible --version` between
+      tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible --version
+
+      ```
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Community.general Version
+    description: >-
+      Paste verbatim output from "ansible-galaxy collection list community.general"
+      between tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible-galaxy collection list community.general
+
+      ```
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Configuration
+    description: >-
+      Paste verbatim output from `ansible-config dump --only-changed` between quotes.
+    value: |
+      ```console (paste below)
+      $ ansible-config dump --only-changed
+
+      ```
+  validations:
+    required: false
+
+- 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: false
+
+- type: textarea
+  attributes:
+    label: Additional Information
+    description: |
+      Describe how this improves the documentation, e.g. before/after situation or screenshots.
+
+      **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them.
+
+      **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: false
+
+- type: checkboxes
+  attributes:
+    label: Code of Conduct
+    description: |
+      Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
+    options:
+    - label: I agree to follow the Ansible Code of Conduct
       required: true
-
-  - type: dropdown
-    attributes:
-      label: Issue Type
-      # 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 file, module, plugin, task or feature below,
-        *use your best guess if unsure*. Do not include `community.general.`!
-      placeholder: mysql_user
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Ansible Version
-      description: >-
-        Paste verbatim output from `ansible --version` between
-        tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible --version
-
-        ```
-    validations:
-      required: false
-
-  - type: textarea
-    attributes:
-      label: Community.general Version
-      description: >-
-        Paste verbatim output from "ansible-galaxy collection list community.general"
-        between tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible-galaxy collection list community.general
-
-        ```
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Configuration
-      description: >-
-        Paste verbatim output from `ansible-config dump --only-changed` between quotes.
-      value: |
-        ```console (paste below)
-        $ ansible-config dump --only-changed
-
-        ```
-    validations:
-      required: false
-
-  - 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: false
-
-  - type: textarea
-    attributes:
-      label: Additional Information
-      description: |
-        Describe how this improves the documentation, e.g. before/after situation or screenshots.
-
-        **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them.
-
-        **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: false
-
-  - type: checkboxes
-    attributes:
-      label: Code of Conduct
-      description: |
-        Read the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
-      options:
-        - label: I agree to follow the Ansible Code of Conduct
-          required: true
 ...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -7,67 +7,67 @@ name: Feature request
 description: Suggest an idea for this project
 
 body:
-  - type: markdown
-    attributes:
-      value: |
-        ⚠
-        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.
-        *Complete **all** sections as described, this form is processed automatically.*
+- type: markdown
+  attributes:
+    value: |
+      ⚠
+      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.
+      *Complete **all** sections as described, this form is processed automatically.*
 
-        [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
+      [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
 
 
-  - type: textarea
-    attributes:
-      label: Summary
-      description: Describe the new feature/improvement briefly below.
-      placeholder: >-
-        I am trying to do X with the collection from the main branch on GitHub and
-        I think that implementing a feature Y would be very helpful for me and
-        every other user of community.general because of Z.
-    validations:
+- type: textarea
+  attributes:
+    label: Summary
+    description: Describe the new feature/improvement briefly below.
+    placeholder: >-
+      I am trying to do X with the collection from the main branch on GitHub and
+      I think that implementing a feature Y would be very helpful for me and
+      every other user of community.general because of Z.
+  validations:
+    required: true
+
+- type: dropdown
+  attributes:
+    label: Issue Type
+    # 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 or plugin, or which other part(s) of the collection this feature affects.
+      *use your best guess if unsure*. Do not include `community.general.`!
+    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)
+
+      ```
+  validations:
+    required: false
+- type: checkboxes
+  attributes:
+    label: Code of Conduct
+    description: |
+      Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
+    options:
+    - label: I agree to follow the Ansible Code of Conduct
       required: true
-
-  - type: dropdown
-    attributes:
-      label: Issue Type
-      # 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 or plugin, or which other part(s) of the collection this feature affects.
-        *use your best guess if unsure*. Do not include `community.general.`!
-      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)
-
-        ```
-    validations:
-      required: false
-  - type: checkboxes
-    attributes:
-      label: Code of Conduct
-      description: |
-        Read the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
-      options:
-        - label: I agree to follow the Ansible Code of Conduct
-          required: true
 ...

.github/dependabot.yml

@@ -9,7 +9,3 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
-    groups:
-      ci:
-        patterns:
-          - "*"

.github/pull_request_template.md

@@ -4,7 +4,7 @@
 <!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
 
 <!--- Please do not forget to include a changelog fragment:
-      https://docs.ansible.com/projects/ansible/devel/community/collection_development_process.html#creating-changelog-fragments
+      https://docs.ansible.com/ansible/devel/community/collection_development_process.html#creating-changelog-fragments
       No need to include one for docs-only or test-only PR, and for new plugin/module PRs.
       Read about more details in CONTRIBUTING.md.
       -->

.github/workflows/ansible-test.yml

@@ -7,7 +7,7 @@
 # https://github.com/marketplace/actions/ansible-test
 
 name: EOL CI
-"on":
+on:
   # Run EOL CI against all pushes (direct commits, also merged PRs), Pull Requests
   push:
     branches:
@@ -29,7 +29,12 @@ jobs:
     strategy:
       matrix:
         ansible:
-          - '2.17'
+          - '2.15'
+    # Ansible-test on various stable branches does not yet work well with cgroups v2.
+    # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04
+    # image for these stable branches. The list of branches where this is necessary will
+    # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28
+    # for the latest list.
     runs-on: ubuntu-latest
     steps:
       - name: Perform sanity testing
@@ -40,10 +45,13 @@ jobs:
           coverage: ${{ github.event_name == 'schedule' && 'always' || 'never' }}
           pull-request-change-detection: 'true'
           testing-type: sanity
-          pre-test-cmd: >-
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.internal_test_tools.git ../../community/internal_test_tools
 
   units:
+    # Ansible-test on various stable branches does not yet work well with cgroups v2.
+    # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04
+    # image for these stable branches. The list of branches where this is necessary will
+    # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28
+    # for the latest list.
     runs-on: ubuntu-latest
     name: EOL Units (Ⓐ${{ matrix.ansible }}+py${{ matrix.python }})
     strategy:
@@ -57,12 +65,12 @@ jobs:
         exclude:
           - ansible: ''
         include:
-          - ansible: '2.17'
-            python: '3.7'
-          - ansible: '2.17'
+          - ansible: '2.15'
+            python: '2.7'
+          - ansible: '2.15'
+            python: '3.5'
+          - ansible: '2.15'
             python: '3.10'
-          - ansible: '2.17'
-            python: '3.12'
 
     steps:
       - name: >-
@@ -82,6 +90,11 @@ jobs:
           testing-type: units
 
   integration:
+    # Ansible-test on various stable branches does not yet work well with cgroups v2.
+    # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04
+    # image for these stable branches. The list of branches where this is necessary will
+    # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28
+    # for the latest list.
     runs-on: ubuntu-latest
     name: EOL I (Ⓐ${{ matrix.ansible }}+${{ matrix.docker }}+py${{ matrix.python }}:${{ matrix.target }})
     strategy:
@@ -98,51 +111,43 @@ jobs:
         exclude:
           - ansible: ''
         include:
-          # 2.17
-          - ansible: '2.17'
-            docker: fedora39
+          # 2.15
+          - ansible: '2.15'
+            docker: alpine3
             python: ''
             target: azp/posix/1/
-          - ansible: '2.17'
-            docker: fedora39
+          - ansible: '2.15'
+            docker: alpine3
             python: ''
             target: azp/posix/2/
-          - ansible: '2.17'
-            docker: fedora39
+          - ansible: '2.15'
+            docker: alpine3
             python: ''
             target: azp/posix/3/
-          - ansible: '2.17'
-            docker: ubuntu2004
+          - ansible: '2.15'
+            docker: fedora37
             python: ''
             target: azp/posix/1/
-          - ansible: '2.17'
-            docker: ubuntu2004
+          - ansible: '2.15'
+            docker: fedora37
             python: ''
             target: azp/posix/2/
-          - ansible: '2.17'
-            docker: ubuntu2004
-            python: ''
-            target: azp/posix/3/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.17'
-            docker: alpine319
+          - ansible: '2.15'
+            docker: fedora37
             python: ''
             target: azp/posix/3/
           # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-          # - ansible: '2.17'
+          # - ansible: '2.13'
           #   docker: default
-          #   python: '3.7'
+          #   python: '3.9'
           #   target: azp/generic/1/
-          # - ansible: '2.17'
+          # - ansible: '2.14'
           #   docker: default
-          #   python: '3.12'
+          #   python: '3.10'
+          #   target: azp/generic/1/
+          # - ansible: '2.15'
+          #   docker: default
+          #   python: '3.9'
           #   target: azp/generic/1/
 
     steps:
@@ -159,15 +164,12 @@ jobs:
           integration-continue-on-error: 'false'
           integration-diff: 'false'
           integration-retry-on-error: 'true'
-          # TODO: remove "--branch stable-2" from community.crypto install once we're only using ansible-core 2.17 or newer!
           pre-test-cmd: >-
             mkdir -p ../../ansible
             ;
             git clone --depth=1 --single-branch https://github.com/ansible-collections/ansible.posix.git ../../ansible/posix
             ;
-            git clone --depth=1 --single-branch --branch stable-2 https://github.com/ansible-collections/community.crypto.git ../../community/crypto
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.docker.git ../../community/docker
+            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.crypto.git ../../community/crypto
             ;
             git clone --depth=1 --single-branch https://github.com/ansible-collections/community.internal_test_tools.git ../../community/internal_test_tools
           pull-request-change-detection: 'true'

.github/workflows/codeql-analysis.yml

@@ -5,7 +5,7 @@
 
 name: "Code scanning - action"
 
-"on":
+on:
   schedule:
     - cron: '26 19 * * 1'
   workflow_dispatch:
@@ -23,16 +23,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v6
-        with:
-          persist-credentials: false
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        persist-credentials: false
 
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v4
-        with:
-          languages: python
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: python
 
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v4
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

.github/workflows/docs.yml

@@ -1,34 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-name: nox
-'on':
-  push:
-    branches:
-      - main
-      - stable-*
-    paths:
-      - docs/**
-  pull_request:
-    paths:
-      - docs/**
-  # Run CI once per day (at 08:00 UTC)
-  schedule:
-    - cron: '0 8 * * *'
-  workflow_dispatch:
-
-jobs:
-  nox:
-    runs-on: ubuntu-latest
-    name: "Validate generated Ansible output"
-    steps:
-      - name: Check out collection
-        uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-      - name: Run nox
-        uses: ansible-community/antsibull-nox@main
-        with:
-          sessions: ansible-output

.github/workflows/import-galaxy.yml

@@ -0,0 +1,20 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+name: import-galaxy
+'on':
+  # Run CI against all pushes (direct commits, also merged PRs) to main, and all Pull Requests
+  push:
+    branches:
+      - main
+      - stable-*
+  pull_request:
+
+jobs:
+  import-galaxy:
+    permissions:
+      contents: read
+    name: Test to import built collection artifact with Galaxy importer
+    uses: ansible-community/github-action-test-galaxy-import/.github/workflows/test-galaxy-import.yml@main

.github/workflows/nox.yml

@@ -1,28 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-name: nox
-'on':
-  push:
-    branches:
-      - main
-      - stable-*
-  pull_request:
-  # Run CI once per day (at 08:00 UTC)
-  schedule:
-    - cron: '0 8 * * *'
-  workflow_dispatch:
-
-jobs:
-  nox:
-    runs-on: ubuntu-latest
-    name: "Run extra sanity tests"
-    steps:
-      - name: Check out collection
-        uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-      - name: Run nox
-        uses: ansible-community/antsibull-nox@main

.github/workflows/reuse.yml

@@ -0,0 +1,35 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+name: Verify REUSE
+
+on:
+  push:
+    branches:
+      - main
+      - stable-*
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - main
+      - stable-*
+  # Run CI once per day (at 07:30 UTC)
+  schedule:
+    - cron: '30 7 * * *'
+
+jobs:
+  check:
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          ref: ${{ github.event.pull_request.head.sha || '' }}
+
+      - name: REUSE Compliance Check
+        uses: fsfe/reuse-action@v5

.gitignore

@@ -383,16 +383,6 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-### Python Patch ###
-# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
-poetry.toml
-
-# ruff
-.ruff_cache/
-
-# LSP config files
-pyrightconfig.json
-
 ### Vim ###
 # Swap
 [._]*.s[a-v][a-z]
@@ -492,10 +482,6 @@ tags
 # https://plugins.jetbrains.com/plugin/12206-codestream
 .idea/codestream.xml
 
-# Azure Toolkit for IntelliJ plugin
-# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
-.idea/**/azureSettings.xml
-
 ### Windows ###
 # Windows thumbnail cache files
 Thumbs.db
@@ -530,4 +516,3 @@ tests/integration/cloud-config-*.ini
 
 # VSCode specific extensions
 .vscode/settings.json
-.ansible

.mypy.ini

@@ -1,216 +0,0 @@
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-[mypy]
-# check_untyped_defs = True
-# disallow_untyped_defs = True
-
-# strict = True -- only try to enable once everything (including dependencies!) is typed
-strict_equality = True
-strict_bytes = True
-
-warn_redundant_casts = True
-# warn_return_any = True
-warn_unreachable = True
-
-[mypy-ansible.*]
-# ansible-core has partial typing information
-follow_untyped_imports = True
-
-# The following imports are Python packages that:
-# 1. We do not install (we can't install everything!);
-# 2. That have type stubs, but we don't install them (again, we can't install everything!); or
-# 3. That have no types and type stubs.
-[mypy-aerospike.*]
-ignore_missing_imports = True
-[mypy-boto3.*]
-ignore_missing_imports = True
-[mypy-bs4.*]
-ignore_missing_imports = True
-[mypy-cgi.*]
-ignore_missing_imports = True
-[mypy-chef.*]
-ignore_missing_imports = True
-[mypy-consul.*]
-ignore_missing_imports = True
-[mypy-credstash.*]
-ignore_missing_imports = True
-[mypy-crypt.*]
-ignore_missing_imports = True
-[mypy-datadog.*]
-ignore_missing_imports = True
-[mypy-dbus.*]
-ignore_missing_imports = True
-[mypy-delinea.*]
-ignore_missing_imports = True
-[mypy-dnf.*]
-ignore_missing_imports = True
-[mypy-dnsimple.*]
-ignore_missing_imports = True
-[mypy-etcd3.*]
-ignore_missing_imports = True
-[mypy-flatdict.*]
-ignore_missing_imports = True
-[mypy-footmark.*]
-ignore_missing_imports = True
-[mypy-fqdn.*]
-ignore_missing_imports = True
-[mypy-func.*]
-ignore_missing_imports = True
-[mypy-gi.*]
-ignore_missing_imports = True
-[mypy-github3.*]
-ignore_missing_imports = True
-[mypy-hashids.*]
-ignore_missing_imports = True
-[mypy-heroku3.*]
-ignore_missing_imports = True
-[mypy-hpe3parclient.*]
-ignore_missing_imports = True
-[mypy-hpe3par_sdk.*]
-ignore_missing_imports = True
-[mypy-hpilo.*]
-ignore_missing_imports = True
-[mypy-hpOneView.*]
-ignore_missing_imports = True
-[mypy-httmock.*]  # TODO!
-ignore_missing_imports = True
-[mypy-influxdb.*]
-ignore_missing_imports = True
-[mypy-jc.*]
-ignore_missing_imports = True
-[mypy-jenkins.*]
-ignore_missing_imports = True
-[mypy-jmespath.*]
-ignore_missing_imports = True
-[mypy-jsonpatch.*]
-ignore_missing_imports = True
-[mypy-kazoo.*]
-ignore_missing_imports = True
-[mypy-keyring.*]
-ignore_missing_imports = True
-[mypy-keystoneauth1.*]
-ignore_missing_imports = True
-[mypy-layman.*]
-ignore_missing_imports = True
-[mypy-ldap.*]
-ignore_missing_imports = True
-[mypy-legacycrypt.*]
-ignore_missing_imports = True
-[mypy-libcloud.*]
-ignore_missing_imports = True
-[mypy-linode.*]
-ignore_missing_imports = True
-[mypy-linode_api4.*]
-ignore_missing_imports = True
-[mypy-lmdb.*]
-ignore_missing_imports = True
-[mypy-logdna.*]
-ignore_missing_imports = True
-[mypy-logstash.*]
-ignore_missing_imports = True
-[mypy-lxc.*]
-ignore_missing_imports = True
-[mypy-manageiq_client.*]
-ignore_missing_imports = True
-[mypy-matrix_client.*]
-ignore_missing_imports = True
-[mypy-memcache.*]
-ignore_missing_imports = True
-[mypy-nc_dnsapi.*]
-ignore_missing_imports = True
-[mypy-nomad.*]
-ignore_missing_imports = True
-[mypy-oci.*]
-ignore_missing_imports = True
-[mypy-oneandone.*]
-ignore_missing_imports = True
-[mypy-opentelemetry.*]
-ignore_missing_imports = True
-[mypy-ovh.*]
-ignore_missing_imports = True
-[mypy-ovirtsdk.*]
-ignore_missing_imports = True
-[mypy-packet.*]
-ignore_missing_imports = True
-[mypy-paho.*]
-ignore_missing_imports = True
-[mypy-pam.*]
-ignore_missing_imports = True
-[mypy-pdpyras.*]
-ignore_missing_imports = True
-[mypy-petname.*]
-ignore_missing_imports = True
-[mypy-pingdom.*]
-ignore_missing_imports = True
-[mypy-portage.*]
-ignore_missing_imports = True
-[mypy-potatoes_that_will_never_be_there.*]
-ignore_missing_imports = True
-[mypy-prettytable.*]
-ignore_missing_imports = True
-[mypy-pubnub_blocks_client.*]
-ignore_missing_imports = True
-[mypy-pushbullet.*]
-ignore_missing_imports = True
-[mypy-pycdlib.*]
-ignore_missing_imports = True
-[mypy-pyghmi.*]
-ignore_missing_imports = True
-[mypy-pylxca.*]
-ignore_missing_imports = True
-[mypy-pymssql.*]
-ignore_missing_imports = True
-[mypy-pyodbc.*]
-ignore_missing_imports = True
-[mypy-pyone.*]
-ignore_missing_imports = True
-[mypy-pypureomapi.*]
-ignore_missing_imports = True
-[mypy-pysnmp.*]
-ignore_missing_imports = True
-[mypy-pyxcli.*]
-ignore_missing_imports = True
-[mypy-rpm.*]
-ignore_missing_imports = True
-[mypy-salt.*]
-ignore_missing_imports = True
-[mypy-selinux.*]
-ignore_missing_imports = True
-[mypy-semantic_version.*]
-ignore_missing_imports = True
-[mypy-sendgrid.*]
-ignore_missing_imports = True
-[mypy-seobject.*]
-ignore_missing_imports = True
-[mypy-sha.*]
-ignore_missing_imports = True
-[mypy-SoftLayer.*]
-ignore_missing_imports = True
-[mypy-spotinst_sdk.*]
-ignore_missing_imports = True
-[mypy-statsd.*]
-ignore_missing_imports = True
-[mypy-storops.*]
-ignore_missing_imports = True
-[mypy-taiga.*]
-ignore_missing_imports = True
-[mypy-thycotic.*]
-ignore_missing_imports = True
-[mypy-univention.*]
-ignore_missing_imports = True
-[mypy-vexatapi.*]
-ignore_missing_imports = True
-[mypy-websocket.*]
-ignore_missing_imports = True
-[mypy-XenAPI.*]
-ignore_missing_imports = True
-[mypy-xkcdpass.*]
-ignore_missing_imports = True
-[mypy-xmljson.*]
-ignore_missing_imports = True
-[mypy-xmltodict.*]
-ignore_missing_imports = True
-[mypy-xmpp.*]
-ignore_missing_imports = True

.reuse/dep5

@@ -0,0 +1,5 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+
+Files: changelogs/fragments/*
+Copyright: Ansible Project
+License: GPL-3.0-or-later

.yamllint

@@ -1,52 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-extends: default
-
-ignore: |
-  /changelogs/
-
-rules:
-  line-length:
-    max: 1000
-    level: error
-  document-start: disable
-  document-end: disable
-  truthy:
-    level: error
-    allowed-values:
-      - 'true'
-      - 'false'
-  indentation:
-    spaces: 2
-    indent-sequences: true
-  key-duplicates: enable
-  trailing-spaces: enable
-  new-line-at-end-of-file: disable
-  hyphens:
-    max-spaces-after: 1
-  empty-lines:
-    max: 2
-    max-start: 0
-    max-end: 0
-  commas:
-    max-spaces-before: 0
-    min-spaces-after: 1
-    max-spaces-after: 1
-  colons:
-    max-spaces-before: 0
-    max-spaces-after: 1
-  brackets:
-    min-spaces-inside: 0
-    max-spaces-inside: 0
-  braces:
-    min-spaces-inside: 0
-    max-spaces-inside: 1
-  octal-values:
-    forbid-implicit-octal: true
-    forbid-explicit-octal: true
-  comments:
-    min-spaces-from-content: 1
-  comments-indentation: false

CONTRIBUTING.md

@@ -6,7 +6,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 
 # Contributing
 
-We follow [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository.
+We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository.
 
 If you are a committer, also refer to the [collection's committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
 
@@ -20,93 +20,33 @@ so you can cooperate to create a better solution together.
 * If you are interested in starting with an easy issue, look for [issues with an `easyfix` label](https://github.com/ansible-collections/community.general/labels/easyfix).
 * Often issues that are waiting for contributors to pick up have [the `waiting_on_contributor` label](https://github.com/ansible-collections/community.general/labels/waiting_on_contributor).
 
-## Review pull requests
+## Open pull requests
 
 Look through currently [open pull requests](https://github.com/ansible-collections/community.general/pulls).
-
 You can help by reviewing them. Reviews help move pull requests to merge state. Some good pull requests cannot be merged only due to a lack of reviews. And it is always worth saying that good reviews are often more valuable than pull requests themselves.
-Note that reviewing does not only mean code review, but also offering comments on new interfaces added to existing plugins/modules, interfaces of new plugins/modules, improving language (not everyone is a native English speaker), or testing bugfixes and new features!
+Note that reviewing does not only mean code review, but also offering comments on new interfaces added to existing plugins/modules, interfaces of new plugins/modules, improving language (not everyone is a native english speaker), or testing bugfixes and new features!
 
 Also, consider taking up a valuable, reviewed, but abandoned pull request which you could politely ask the original authors to complete yourself.
 
-## Open pull requests
-
-Please read our ['Contributing to collections'](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_collections_contributing.html#contributing-to-a-collection-community-general) guide.
-
 * Try committing your changes with an informative but short commit message.
 * Do not squash your commits and force-push to your branch if not needed. Reviews of your pull request are much easier with individual commits to comprehend the pull request history. All commits of your pull request branch will be squashed into one commit by GitHub upon merge.
-* Do not add merge commits to your PR. The bot will complain and you will have to rebase ([instructions for rebasing](https://docs.ansible.com/projects/ansible/latest/dev_guide/developing_rebasing.html)) to remove them before your PR can be merged. To avoid that git automatically does merges during pulls, you can configure it to do rebases instead by running `git config pull.rebase true` inside the repository checkout.
-* Make sure your PR includes a [changelog fragment](https://docs.ansible.com/projects/ansible/devel/community/collection_development_process.html#creating-a-changelog-fragment).
+* Do not add merge commits to your PR. The bot will complain and you will have to rebase ([instructions for rebasing](https://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html)) to remove them before your PR can be merged. To avoid that git automatically does merges during pulls, you can configure it to do rebases instead by running `git config pull.rebase true` inside the repository checkout.
+* Make sure your PR includes a [changelog fragment](https://docs.ansible.com/ansible/devel/community/collection_development_process.html#creating-a-changelog-fragment).
   * You must not include a fragment for new modules or new plugins. Also you shouldn't include one for docs-only changes. (If you're not sure, simply don't include one, we'll tell you whether one is needed or not :) )
   * Please always include a link to the pull request itself, and if the PR is about an issue, also a link to the issue. Also make sure the fragment ends with a period, and begins with a lower-case letter after `-`. (Again, if you don't do this, we'll add suggestions to fix it, so don't worry too much :) )
-* Note that we format the code with `ruff format`. If your change does not match the formatters expectations, CI will fail and your PR will not get merged. See below for how to format code with antsibull-nox.
+* Avoid reformatting unrelated parts of the codebase in your PR. These types of changes will likely be requested for reversion, create additional work for reviewers, and may cause approval to be delayed.
 
-You can also read the Ansible community's [Quick-start development guide](https://docs.ansible.com/projects/ansible/devel/community/create_pr_quick_start.html).
+You can also read [our Quick-start development guide](https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst).
 
 ## Test pull requests
 
-If you want to test a PR locally, refer to [our testing guide](https://docs.ansible.com/projects/ansible/devel/community/collection_contributors/collection_test_pr_locally.html) for instructions on how do it quickly.
+If you want to test a PR locally, refer to [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how do it quickly.
 
 If you find any inconsistencies or places in this document which can be improved, feel free to raise an issue or pull request to fix it.
 
-## Format code; and run sanity or unit tests locally (with antsibull-nox)
+## Run sanity, unit or integration tests locally
 
-The easiest way to format the code, and to run sanity and unit tests locally is to use [antsibull-nox](https://docs.ansible.com/projects/antsibull-nox/).
-(If you have [nox](https://nox.thea.codes/en/stable/) installed, it will automatically install antsibull-nox in a virtual environment for you.)
-
-### Format code
-
-The following commands show how to run ansible-test sanity tests:
-
-```.bash
-# Run all configured formatters:
-nox -Re formatters
-
-# If you notice discrepancies between your local formatter and CI, you might
-# need to re-generate the virtual environment:
-nox -e formatters
-```
-
-### Sanity tests
-
-The following commands show how to run ansible-test sanity tests:
-
-```.bash
-# Run basic sanity tests for all files in the collection:
-nox -Re ansible-test-sanity-devel
-
-# Run basic sanity tests for the given files and directories:
-nox -Re ansible-test-sanity-devel -- plugins/modules/system/pids.py tests/integration/targets/pids/
-
-# Run all other sanity tests for all files in the collection:
-nox -R
-```
-
-If you replace `-Re` with `-e`, respectively. If you leave `-R` away, then the virtual environments will be re-created. The `-R` re-uses them (if they already exist).
-
-### Unit tests
-
-The following commands show how to run unit tests:
-
-```.bash
-# Run all unit tests:
-nox -Re ansible-test-units-devel
-
-# Run all unit tests for one Python version (a lot faster):
-nox -Re ansible-test-units-devel -- --python 3.13
-
-# Run a specific unit test (for the nmcli module) for one Python version:
-nox -Re ansible-test-units-devel -- --python 3.13 tests/unit/plugins/modules/net_tools/test_nmcli.py
-```
-
-If you replace `-Re` with `-e`, then the virtual environments will be re-created. The `-R` re-uses them (if they already exist).
-
-## Run basic sanity, unit or integration tests locally (with ansible-test)
-
-Instead of using antsibull-nox, you can also run sanity and unit tests with ansible-test directly.
-This also allows you to run integration tests.
-
-You have to check out the repository into a specific path structure to be able to run `ansible-test`. The path to the git checkout must end with `.../ansible_collections/community/general`. Please see [our testing guide](https://docs.ansible.com/projects/ansible/devel/community/collection_contributors/collection_test_pr_locally.html) for instructions on how to check out the repository into a correct path structure. The short version of these instructions is:
+You have to check out the repository into a specific path structure to be able to run `ansible-test`. The path to the git checkout must end with `.../ansible_collections/community/general`. Please see [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how to check out the repository into a correct path structure. The short version of these instructions is:
 
 ```.bash
 mkdir -p ~/dev/ansible_collections/community
@@ -116,27 +56,20 @@ cd ~/dev/ansible_collections/community/general
 
 Then you can run `ansible-test` (which is a part of [ansible-core](https://pypi.org/project/ansible-core/)) inside the checkout. The following example commands expect that you have installed Docker or Podman. Note that Podman has only been supported by more recent ansible-core releases. If you are using Docker, the following will work with Ansible 2.9+.
 
-### Basic sanity tests
+### Sanity tests
 
-The following commands show how to run basic sanity tests:
+The following commands show how to run sanity tests:
 
 ```.bash
-# Run basic sanity tests for all files in the collection:
+# Run sanity tests for all files in the collection:
 ansible-test sanity --docker -v
 
-# Run basic sanity tests for the given files and directories:
+# Run sanity tests for the given files and directories:
 ansible-test sanity --docker -v plugins/modules/system/pids.py tests/integration/targets/pids/
 ```
 
 ### Unit tests
 
-Note that for running unit tests, you need to install required collections in the same folder structure that `community.general` is checked out in.
-Right now, you need to install [`community.internal_test_tools`](https://github.com/ansible-collections/community.internal_test_tools).
-If you want to use the latest version from GitHub, you can run:
-```
-git clone https://github.com/ansible-collections/community.internal_test_tools.git ~/dev/ansible_collections/community/internal_test_tools
-```
-
 The following commands show how to run unit tests:
 
 ```.bash
@@ -152,16 +85,6 @@ ansible-test units --docker -v --python 3.8 tests/unit/plugins/modules/net_tools
 
 ### Integration tests
 
-Note that for running integration tests, you need to install required collections in the same folder structure that `community.general` is checked out in.
-Right now, depending on the test, you need to install [`ansible.posix`](https://github.com/ansible-collections/ansible.posix), [`community.crypto`](https://github.com/ansible-collections/community.crypto), and [`community.docker`](https://github.com/ansible-collections/community.docker):
-If you want to use the latest versions from GitHub, you can run:
-```
-mkdir -p ~/dev/ansible_collections/ansible
-git clone https://github.com/ansible-collections/ansible.posix.git ~/dev/ansible_collections/ansible/posix
-git clone https://github.com/ansible-collections/community.crypto.git ~/dev/ansible_collections/community/crypto
-git clone https://github.com/ansible-collections/community.docker.git ~/dev/ansible_collections/community/docker
-```
-
 The following commands show how to run integration tests:
 
 #### In Docker
@@ -169,8 +92,8 @@ The following commands show how to run integration tests:
 Integration tests on Docker have the following parameters:
 - `image_name` (required): The name of the Docker image. To get the list of supported Docker images, run
   `ansible-test integration --help` and look for _target docker images_.
-- `test_name` (optional): The name of the integration test.
-  For modules, this equals the short name of the module; for example, `pacman` in case of `community.general.pacman`.
+- `test_name` (optional): The name of the integration test.  
+  For modules, this equals the short name of the module; for example, `pacman` in case of `community.general.pacman`.  
   For plugins, the plugin type is added before the plugin's short name, for example `callback_yaml` for the `community.general.yaml` callback.
 ```.bash
 # Test all plugins/modules on fedora40
@@ -206,9 +129,9 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
 
 3. When creating a new module or plugin, please make sure that you follow various guidelines:
 
-   - Follow [development conventions](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_modules_best_practices.html);
-   - Follow [documentation standards](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_modules_documenting.html) and
-     the [Ansible style guide](https://docs.ansible.com/projects/ansible/devel/dev_guide/style_guide/index.html#style-guide);
+   - Follow [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html);
+   - Follow [documentation standards](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html) and
+     the [Ansible style guide](https://docs.ansible.com/ansible/devel/dev_guide/style_guide/index.html#style-guide);
    - Make sure your modules and plugins are [GPL-3.0-or-later](https://www.gnu.org/licenses/gpl-3.0-standalone.html) licensed
      (new module_utils can also be [BSD-2-clause](https://opensource.org/licenses/BSD-2-Clause) licensed);
    - Make sure that new plugins and modules have tests (unit tests, integration tests, or both); it is preferable to have some tests

LICENSES/PSF-2.0.txt

@@ -0,0 +1,48 @@
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+--------------------------------------------
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+("PSF"), and the Individual or Organization ("Licensee") accessing and
+otherwise using this software ("Python") in source or binary form and
+its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF hereby
+grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+analyze, test, perform and/or display publicly, prepare derivative works,
+distribute, and otherwise use Python alone or in any derivative version,
+provided, however, that PSF's License Agreement and PSF's notice of copyright,
+i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
+2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Python Software Foundation;
+All Rights Reserved" are retained in Python alone or in any derivative version
+prepared by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS"
+basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between PSF and
+Licensee.  This License Agreement does not grant permission to use PSF
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.

README.md

@@ -6,24 +6,23 @@ SPDX-License-Identifier: GPL-3.0-or-later
 
 # Community General Collection
 
-[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://docs.ansible.com/projects/ansible/devel/collections/community/general/)
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-12)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
-[![EOL CI](https://github.com/ansible-collections/community.general/actions/workflows/ansible-test.yml/badge.svg?branch=stable-12)](https://github.com/ansible-collections/community.general/actions)
-[![Nox CI](https://github.com/ansible-collections/community.general/actions/workflows/nox.yml/badge.svg?branch=stable-12)](https://github.com/ansible-collections/community.general/actions)
+[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://docs.ansible.com/ansible/latest/collections/community/general/)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-10)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![EOL CI](https://github.com/ansible-collections/community.general/actions/workflows/ansible-test.yml/badge.svg?branch=stable-10)](https://github.com/ansible-collections/community.general/actions)
 [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
 [![REUSE status](https://api.reuse.software/badge/github.com/ansible-collections/community.general)](https://api.reuse.software/info/github.com/ansible-collections/community.general)
 
 This repository contains the `community.general` Ansible Collection. The collection is a part of the Ansible package and includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
 
-You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/projects/ansible/latest/collections/community/general/).
+You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/).
 
 Please note that this collection does **not** support Windows targets. Only connection plugins included in this collection might support Windows targets, and will explicitly mention that in their documentation if they do so.
 
 ## Code of Conduct
 
-We follow [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html) in all our interactions within this project.
+We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our interactions within this project.
 
-If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
+If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
 
 ## Communication
 
@@ -33,13 +32,13 @@ If you encounter abusive behavior violating the [Ansible Code of Conduct](https:
   * [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
   * [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
 
-* The Ansible [Bullhorn newsletter](https://docs.ansible.com/projects/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
+* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
 
-For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/projects/ansible/devel/community/communication.html).
+For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
 
 ## Tested with Ansible
 
-Tested with the current ansible-core 2.17, ansible-core 2.18, ansible-core 2.19, ansible-core 2.20 releases and the current development version of ansible-core. Ansible-core versions before 2.17.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
+Tested with the current ansible-core 2.15, ansible-core 2.16, ansible-core 2.17, ansible-core 2.18 releases and the current development version of ansible-core. Ansible-core versions before 2.15.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
 
 ## External requirements
 
@@ -47,7 +46,7 @@ Some modules and plugins require external libraries. Please check the requiremen
 
 ## Included content
 
-Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/ui/repo/published/community/general/) or the [documentation on the Ansible docs site](https://docs.ansible.com/projects/ansible/latest/collections/community/general/).
+Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/ui/repo/published/community/general/) or the [documentation on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/).
 
 ## Using this collection
 
@@ -76,7 +75,7 @@ You can also install a specific version of the collection, for example, if you n
 ansible-galaxy collection install community.general:==X.Y.Z
 ```
 
-See [Ansible Using collections](https://docs.ansible.com/projects/ansible/latest/user_guide/collections_using.html) for more details.
+See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
 
 ## Contributing to this collection
 
@@ -86,31 +85,31 @@ We are actively accepting new contributors.
 
 All types of contributions are very welcome.
 
-You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/stable-12/CONTRIBUTING.md)!
+You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md)!
 
-The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/stable-12/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
+The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
 
-You can find more information in the [developer guide for collections](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/projects/ansible/latest/community/index.html).
+You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
 
-Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/stable-12/CONTRIBUTING.md).
+Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md).
 
 ### Running tests
 
-See [here](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_collections.html#testing-collections).
+See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections).
 
 ## Collection maintenance
 
 To learn how to maintain / become a maintainer of this collection, refer to:
 
-* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/stable-12/commit-rights.md).
-* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/stable-12/maintaining.rst).
+* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
+* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
 
 It is necessary for maintainers of this collection to be subscribed to:
 
 * The collection itself (the `Watch` button → `All Activity` in the upper right corner of the repository's homepage).
 * The "Changes Impacting Collection Contributors and Maintainers" [issue](https://github.com/ansible-collections/overview/issues/45).
 
-They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/projects/ansible/devel/community/communication.html#the-bullhorn).
+They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).
 
 ## Publishing New Version
 
@@ -118,7 +117,7 @@ See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/ma
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-12/CHANGELOG.md).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-10/CHANGELOG.md).
 
 ## Roadmap
 
@@ -129,16 +128,16 @@ See [this issue](https://github.com/ansible-collections/community.general/issues
 ## More information
 
 - [Ansible Collection overview](https://github.com/ansible-collections/overview)
-- [Ansible User guide](https://docs.ansible.com/projects/ansible/latest/user_guide/index.html)
-- [Ansible Developer guide](https://docs.ansible.com/projects/ansible/latest/dev_guide/index.html)
-- [Ansible Community code of conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html)
+- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
+- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
+- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
 
 ## Licensing
 
 This collection is primarily licensed and distributed as a whole under the GNU General Public License v3.0 or later.
 
-See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/stable-12/COPYING) for the full text.
+See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/stable-10/COPYING) for the full text.
 
-Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/stable-12/LICENSES/BSD-2-Clause.txt) and the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-12/LICENSES/MIT.txt).
+Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/stable-10/LICENSES/BSD-2-Clause.txt), the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-10/LICENSES/MIT.txt), and the [PSF 2.0 license](https://github.com/ansible-collections/community.general/blob/stable-10/LICENSES/PSF-2.0.txt).
 
-All files have a machine readable `SDPX-License-Identifier:` comment denoting its respective license(s) or an equivalent entry in an accompanying `.license` file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in `REUSE.toml`. This conforms to the [REUSE specification](https://reuse.software/spec/).
+All files have a machine readable `SDPX-License-Identifier:` comment denoting its respective license(s) or an equivalent entry in an accompanying `.license` file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in `.reuse/dep5`. This conforms to the [REUSE specification](https://reuse.software/spec/).

REUSE.toml

@@ -1,11 +0,0 @@
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-version = 1
-
-[[annotations]]
-path = "changelogs/fragments/**"
-precedence = "aggregate"
-SPDX-FileCopyrightText = "Ansible Project"
-SPDX-License-Identifier = "GPL-3.0-or-later"

antsibull-nox.toml

@@ -1,116 +0,0 @@
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-# SPDX-FileCopyrightText: 2025 Felix Fontein <felix@fontein.de>
-
-[collection_sources]
-"ansible.posix" = "git+https://github.com/ansible-collections/ansible.posix.git,main"
-"community.crypto" = "git+https://github.com/ansible-collections/community.crypto.git,main"
-"community.docker" = "git+https://github.com/ansible-collections/community.docker.git,main"
-"community.internal_test_tools" = "git+https://github.com/ansible-collections/community.internal_test_tools.git,main"
-
-[collection_sources_per_ansible.'2.16']
-# community.crypto's main branch needs ansible-core >= 2.17
-"community.crypto" = "git+https://github.com/ansible-collections/community.crypto.git,stable-2"
-
-[vcs]
-vcs = "git"
-development_branch = "main"
-stable_branches = [ "stable-*" ]
-
-[sessions]
-
-[sessions.lint]
-run_isort = false
-run_black = false
-run_ruff_check = true
-ruff_check_config = "ruff.toml"
-run_ruff_format = true
-ruff_format_config = "ruff.toml"
-run_flake8 = false
-run_pylint = false
-run_yamllint = true
-yamllint_config = ".yamllint"
-# yamllint_config_plugins = ".yamllint-docs"
-# yamllint_config_plugins_examples = ".yamllint-examples"
-run_mypy = true
-mypy_ansible_core_package = "ansible-core>=2.19.0"
-mypy_config = ".mypy.ini"
-mypy_extra_deps = [
-    "cryptography",
-    "dnspython",
-    "lxml-stubs",
-    "types-mock",
-    "types-paramiko",
-    "types-passlib",
-    "types-psutil",
-    "types-PyYAML",
-    "types-requests",
-]
-
-[sessions.docs_check]
-validate_collection_refs="all"
-codeblocks_restrict_types = [
-    "ansible-output",
-    "console",
-    "ini",
-    "json",
-    "python",
-    "shell",
-    "yaml",
-    "yaml+jinja",
-    "text",
-]
-codeblocks_restrict_type_exact_case = true
-codeblocks_allow_without_type = false
-codeblocks_allow_literal_blocks = false
-
-[sessions.license_check]
-
-[sessions.extra_checks]
-run_no_unwanted_files = true
-no_unwanted_files_module_extensions = [".py"]
-no_unwanted_files_yaml_extensions = [".yml"]
-run_action_groups = true
-run_no_trailing_whitespace = true
-no_trailing_whitespace_skip_paths = [
-    "tests/integration/targets/iso_extract/files/test.iso",
-    "tests/integration/targets/java_cert/files/testpkcs.p12",
-    "tests/integration/targets/one_host/files/testhost/tmp/opennebula-fixtures.json.gz",
-    "tests/integration/targets/one_template/files/testhost/tmp/opennebula-fixtures.json.gz",
-    "tests/integration/targets/setup_flatpak_remote/files/repo.tar.xz",
-]
-no_trailing_whitespace_skip_directories = [
-    "tests/unit/plugins/modules/interfaces_file/interfaces_file_fixtures/golden_output/",
-    "tests/unit/plugins/modules/interfaces_file/interfaces_file_fixtures/input/",
-]
-
-[[sessions.extra_checks.action_groups_config]]
-name = "consul"
-pattern = "^consul_.*$"
-exclusions = [
-    "consul_acl_bootstrap",
-    "consul_kv",
-]
-doc_fragment = "community.general.consul.actiongroup_consul"
-
-[[sessions.extra_checks.action_groups_config]]
-name = "keycloak"
-pattern = "^keycloak_.*$"
-exclusions = [
-    "keycloak_realm_info",
-]
-doc_fragment = "community.general.keycloak.actiongroup_keycloak"
-
-[[sessions.extra_checks.action_groups_config]]
-name = "scaleway"
-pattern = "^scaleway_.*$"
-doc_fragment = "community.general.scaleway.actiongroup_scaleway"
-
-[sessions.build_import_check]
-run_galaxy_importer = true
-
-[sessions.ansible_test_sanity]
-include_devel = true
-
-[sessions.ansible_test_units]
-include_devel = true

changelogs/config.yaml

@@ -7,9 +7,9 @@ changelog_filename_template: ../CHANGELOG.rst
 changelog_filename_version_depth: 0
 changes_file: changelog.yaml
 changes_format: combined
-ignore_other_fragment_extensions: true
 keep_fragments: false
 mention_ancestor: true
+flatmap: true
 new_plugins_after_name: removed_features
 notesdir: fragments
 output_formats:
@@ -40,4 +40,3 @@ use_fqcn: true
 add_plugin_period: true
 changelog_nice_yaml: true
 changelog_sort: version
-vcs: auto

commit-rights.md

@@ -7,7 +7,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 Committers Guidelines for community.general
 ===========================================
 
-This document is based on the [Ansible committer guidelines](https://github.com/ansible/ansible/blob/b57444af14062ec96e0af75fdfc2098c74fe2d9a/docs/docsite/rst/community/committer_guidelines.rst) ([latest version](https://docs.ansible.com/projects/ansible/devel/community/committer_guidelines.html)).
+This document is based on the [Ansible committer guidelines](https://github.com/ansible/ansible/blob/b57444af14062ec96e0af75fdfc2098c74fe2d9a/docs/docsite/rst/community/committer_guidelines.rst) ([latest version](https://docs.ansible.com/ansible/devel/community/committer_guidelines.html)).
 
 These are the guidelines for people with commit privileges on the Ansible Community General Collection GitHub repository. Please read the guidelines before you commit.
 
@@ -45,7 +45,7 @@ Individuals with direct commit access to this collection repository are entruste
   - Do not commit directly.
   - Do not merge your own PRs. Someone else should have a chance to review and approve the PR merge. You have a small amount of leeway here for very minor changes.
   - Do not forget about non-standard / alternate environments. Consider the alternatives. Yes, people have bad/unusual/strange environments (like binaries from multiple init systems installed), but they are the ones who need us the most.
-  - Do not drag your community team members down. Discuss the technical merits of any pull requests you review. Avoid negativity and personal comments. For more guidance on being a good community member, read the [Ansible Community Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html).
+  - Do not drag your community team members down. Discuss the technical merits of any pull requests you review. Avoid negativity and personal comments. For more guidance on being a good community member, read the [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
   - Do not forget about the maintenance burden. High-maintenance features may not be worth adding.
   - Do not break playbooks. Always keep backwards compatibility in mind.
   - Do not forget to keep it simple. Complexity breeds all kinds of problems.

docs/docsite/config.yml

@@ -5,13 +5,3 @@
 
 changelog:
   write_changelog: true
-
-ansible_output:
-  global_env:
-    ANSIBLE_STDOUT_CALLBACK: community.general.tasks_only
-    ANSIBLE_COLLECTIONS_TASKS_ONLY_NUMBER_OF_COLUMNS: 90
-  global_postprocessors:
-    reformat-yaml:
-      command:
-        - python
-        - docs/docsite/reformat-yaml.py

docs/docsite/extra-docs.yml

@@ -8,10 +8,9 @@ sections:
     toctree:
       - filter_guide
       - test_guide
-  - title: Technology Guides
+  - title: Cloud Guides
     toctree:
       - guide_alicloud
-      - guide_iocage
       - guide_online
       - guide_packet
       - guide_scaleway

docs/docsite/helper/keep_keys/README.md

@@ -0,0 +1,61 @@
+<!--
+Copyright (c) Ansible Project
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
+
+# Docs helper. Create RST file.
+
+The playbook `playbook.yml` writes a RST file that can be used in
+docs/docsite/rst. The usage of this helper is recommended but not
+mandatory. You can stop reading here and update the RST file manually
+if you don't want to use this helper.
+
+## Run the playbook
+
+If you want to generate the RST file by this helper fit the variables
+in the playbook and the template to your needs. Then, run the play
+
+```sh
+shell> ansible-playbook playbook.yml
+```
+
+## Copy RST to docs/docsite/rst
+
+Copy the RST file to `docs/docsite/rst` and remove it from this
+directory.
+
+## Update the checksums
+
+Substitute the variables and run the below commands
+
+```sh
+shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
+shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
+```
+
+## Playbook explained
+
+The playbook includes the variable *tests* from the integration tests
+and creates the RST file from the template. The playbook will
+terminate if:
+
+* The file with the variable *tests* was changed
+* The RST file was changed
+
+This means that this helper is probably not up to date.
+
+### The file with the variable *tests* was changed
+
+This means that somebody updated the integration tests. Review the
+changes and update the template if needed. Update the checksum to pass
+the integrity test. The playbook message provides you with the
+command.
+
+### The RST file was changed
+
+This means that somebody updated the RST file manually. Review the
+changes and update the template. Update the checksum to pass the
+integrity test. The playbook message provides you with the
+command. Make sure that the updated template will create identical RST
+file. Only then apply your changes.

docs/docsite/helper/keep_keys/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst.j2

@@ -0,0 +1,80 @@
+..
+  Copyright (c) Ansible Project
+  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+keep_keys
+"""""""""
+
+Use the filter :ansplugin:`community.general.keep_keys#filter` if you have a list of dictionaries and want to keep certain keys only.
+
+.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
+
+
+Let us use the below list in the following examples:
+
+.. code-block:: yaml
+
+   input:
+     {{ tests.0.input | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[0:1]|subelements('group') %}
+* {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1
+
+   target: {{ i.1.tt }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}
+
+gives
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.0.result | to_yaml(indent=2) | indent(5) }}
+ 
+.. versionadded:: 9.1.0
+
+* The results of the below examples 1-5 are all the same:
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.1.result | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[1:2]|subelements('group') %}
+{{ loop.index }}. {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1,2
+
+   mp: {{ i.1.mp }}
+   target: {{ i.1.tt }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}
+
+* The results of the below examples 6-9 are all the same:
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.2.result | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[2:3]|subelements('group') %}
+{{ loop.index + 5 }}. {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1,2
+
+   mp: {{ i.1.mp }}
+   target: {{ i.1.tt }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}

docs/docsite/helper/keep_keys/keep_keys.rst.sha1

@@ -0,0 +1 @@
+8690afce792abc95693c2f61f743ee27388b1592  ../../rst/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst

docs/docsite/helper/keep_keys/playbook.yml

@@ -0,0 +1,79 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# Create docs REST files
+# shell> ansible-playbook playbook.yml
+#
+# Proofread and copy created *.rst file into the directory
+# docs/docsite/rst. Do not add *.rst in this directory to the version
+# control.
+#
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# community.general/docs/docsite/helper/keep_keys/playbook.yml
+
+- name: Create RST file for docs/docsite/rst
+  hosts: localhost
+  gather_facts: false
+
+  vars:
+
+    plugin: keep_keys
+    plugin_type: filter
+    docs_path:
+      - filter_guide
+      - abstract_informations
+      - lists_of_dictionaries
+
+    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
+    file_rst: ../../rst/{{ file_base }}.rst
+    file_sha1: "{{ plugin }}.rst.sha1"
+
+    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
+    target_vars: "{{ target }}/vars/main/tests.yml"
+    target_sha1: tests.yml.sha1
+
+  tasks:
+
+    - name: Test integrity tests.yml
+      when:
+        - integrity | d(true) | bool
+        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
+      block:
+
+        - name: Changed tests.yml
+          ansible.builtin.debug:
+            msg: |
+              Changed {{ target_vars }}
+              Review the changes and update {{ target_sha1 }}
+              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
+
+        - name: Changed tests.yml end host
+          ansible.builtin.meta: end_play
+
+    - name: Test integrity RST file
+      when:
+        - integrity | d(true) | bool
+        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
+      block:
+
+        - name: Changed RST file
+          ansible.builtin.debug:
+            msg: |
+              Changed {{ file_rst }}
+              Review the changes and update {{ file_sha1 }}
+              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
+
+        - name: Changed RST file end host
+          ansible.builtin.meta: end_play
+
+    - name: Include target vars
+      include_vars:
+        file: "{{ target_vars }}"
+
+    - name: Create RST file
+      ansible.builtin.template:
+        src: "{{ file_base }}.rst.j2"
+        dest: "{{ file_base }}.rst"

docs/docsite/helper/keep_keys/tests.yml.sha1

@@ -0,0 +1 @@
+c6fc4ee2017d9222675bcd13cc4f88ba8d14f38d  ../../../../tests/integration/targets/filter_keep_keys/vars/main/tests.yml

docs/docsite/helper/lists_mergeby/default-common.yml

@@ -0,0 +1,12 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list1:
+  - {name: foo, extra: true}
+  - {name: bar, extra: false}
+  - {name: meh, extra: true}
+
+list2:
+  - {name: foo, path: /foo}
+  - {name: baz, path: /baz}

docs/docsite/helper/lists_mergeby/default-recursive-true.yml

@@ -0,0 +1,21 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list1:
+  - name: myname01
+    param01:
+      x: default_value
+      y: default_value
+      list: [default_value]
+  - name: myname02
+    param01: [1, 1, 2, 3]
+
+list2:
+  - name: myname01
+    param01:
+      y: patch_value
+      z: patch_value
+      list: [patch_value]
+  - name: myname02
+    param01: [3, 4, 4]

docs/docsite/helper/lists_mergeby/example-001.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 1. Merge two lists by common attribute 'name'
+  include_vars:
+    dir: example-001_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-001.out

docs/docsite/helper/lists_mergeby/example-001_vars/default-common.yml

@@ -0,0 +1 @@
+../default-common.yml

docs/docsite/helper/lists_mergeby/example-001_vars/list3.yml

@@ -2,5 +2,5 @@
 # Copyright (c) Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
-
-openjdk_pkg: java-21-openjdk-headless
+list3: "{{ list1 |
+           community.general.lists_mergeby(list2, 'name') }}"

docs/docsite/helper/lists_mergeby/example-002.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 2. Merge two lists by common attribute 'name'
+  include_vars:
+    dir: example-002_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-002.out

docs/docsite/helper/lists_mergeby/example-002_vars/default-common.yml

@@ -0,0 +1 @@
+../default-common.yml

docs/docsite/helper/lists_mergeby/example-002_vars/list3.yml

@@ -2,5 +2,5 @@
 # Copyright (c) Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
-
-openjdk_pkg: openjdk-17-jre-headless
+list3: "{{ [list1, list2] |
+           community.general.lists_mergeby('name') }}"

docs/docsite/helper/lists_mergeby/example-003.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 3. Merge recursive by 'name', replace lists (default)
+  include_vars:
+    dir: example-003_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-003.out

docs/docsite/helper/lists_mergeby/example-003_vars/default-recursive-true.yml

@@ -0,0 +1 @@
+../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-003_vars/list3.yml

@@ -0,0 +1,7 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list3: "{{ [list1, list2] |
+           community.general.lists_mergeby('name',
+                                           recursive=true) }}"

docs/docsite/helper/lists_mergeby/example-004.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 4. Merge recursive by 'name', keep lists
+  include_vars:
+    dir: example-004_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-004.out

docs/docsite/helper/lists_mergeby/example-004_vars/default-recursive-true.yml

@@ -0,0 +1 @@
+../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-004_vars/list3.yml

@@ -0,0 +1,8 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list3: "{{ [list1, list2] |
+           community.general.lists_mergeby('name',
+                                           recursive=true,
+                                           list_merge='keep') }}"

docs/docsite/helper/lists_mergeby/example-005.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 5. Merge recursive by 'name', append lists
+  include_vars:
+    dir: example-005_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-005.out

docs/docsite/helper/lists_mergeby/example-005_vars/default-recursive-true.yml

@@ -0,0 +1 @@
+../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-005_vars/list3.yml

@@ -0,0 +1,8 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list3: "{{ [list1, list2] |
+           community.general.lists_mergeby('name',
+                                           recursive=true,
+                                           list_merge='append') }}"

docs/docsite/helper/lists_mergeby/example-006.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 6. Merge recursive by 'name', prepend lists
+  include_vars:
+    dir: example-006_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-006.out

docs/docsite/helper/lists_mergeby/example-006_vars/default-recursive-true.yml

@@ -0,0 +1 @@
+../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-006_vars/list3.yml

@@ -0,0 +1,8 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list3: "{{ [list1, list2] |
+           community.general.lists_mergeby('name',
+                                           recursive=true,
+                                           list_merge='prepend') }}"

docs/docsite/helper/lists_mergeby/example-007.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 7. Merge recursive by 'name', append lists 'remove present'
+  include_vars:
+    dir: example-007_vars
+- debug:
+    var: list3
+  when: debug|d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-007.out

docs/docsite/helper/lists_mergeby/example-007_vars/default-recursive-true.yml

@@ -0,0 +1 @@
+../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-007_vars/list3.yml

@@ -0,0 +1,8 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list3: "{{ [list1, list2] |
+           community.general.lists_mergeby('name',
+                                           recursive=true,
+                                           list_merge='append_rp') }}"

docs/docsite/helper/lists_mergeby/example-008.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 8. Merge recursive by 'name', prepend lists 'remove present'
+  include_vars:
+    dir: example-008_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-008.out

docs/docsite/helper/lists_mergeby/example-008_vars/default-recursive-true.yml

@@ -0,0 +1 @@
+../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-008_vars/list3.yml

@@ -0,0 +1,8 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+list3: "{{ [list1, list2] |
+           community.general.lists_mergeby('name',
+                                           recursive=true,
+                                           list_merge='prepend_rp') }}"

docs/docsite/helper/lists_mergeby/example-009.yml

@@ -0,0 +1,14 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 9. Merge single list by common attribute 'name'
+  include_vars:
+    dir: example-009_vars
+- debug:
+    var: list3
+  when: debug | d(false) | bool
+- template:
+    src: list3.out.j2
+    dest: example-009.out

docs/docsite/helper/lists_mergeby/example-009_vars/default-common.yml

@@ -0,0 +1 @@
+../default-common.yml

docs/docsite/helper/lists_mergeby/example-009_vars/list3.yml

@@ -2,5 +2,5 @@
 # Copyright (c) Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
-
-openjdk_pkg: openjdk-17-jre-headless
+list3: "{{ [list1 + list2, []] |
+           community.general.lists_mergeby('name') }}"

docs/docsite/helper/lists_mergeby/examples.yml

@@ -0,0 +1,78 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+examples:
+  - title: Two lists
+    description: 'In the example below the lists are merged by the attribute ``name``:'
+    file: example-001_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces:'
+    file: example-001.out
+    lang: 'yaml'
+  - title: List of two lists
+    description: 'It is possible to use a list of lists as an input of the filter:'
+    file: example-002_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces the same result as in the previous example:'
+    file: example-002.out
+    lang: 'yaml'
+  - title: Single list
+    description: 'It is possible to merge single list:'
+    file: example-009_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces the same result as in the previous example:'
+    file: example-009.out
+    lang: 'yaml'
+  - title: list_merge=replace (default)
+    description: 'Example :ansopt:`community.general.lists_mergeby#filter:list_merge=replace` (default):'
+    file: example-003_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces:'
+    file: example-003.out
+    lang: 'yaml'
+  - title: list_merge=keep
+    description: 'Example :ansopt:`community.general.lists_mergeby#filter:list_merge=keep`:'
+    file: example-004_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces:'
+    file: example-004.out
+    lang: 'yaml'
+  - title: list_merge=append
+    description: 'Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append`:'
+    file: example-005_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces:'
+    file: example-005.out
+    lang: 'yaml'
+  - title: list_merge=prepend
+    description: 'Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend`:'
+    file: example-006_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces:'
+    file: example-006.out
+    lang: 'yaml'
+  - title: list_merge=append_rp
+    description: 'Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append_rp`:'
+    file: example-007_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces:'
+    file: example-007.out
+    lang: 'yaml'
+  - title: list_merge=prepend_rp
+    description: 'Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend_rp`:'
+    file: example-008_vars/list3.yml
+    lang: 'yaml+jinja'
+  - title:
+    description: 'This produces:'
+    file: example-008.out
+    lang: 'yaml'

docs/docsite/helper/lists_mergeby/examples_all.rst.j2

@@ -3,13 +3,11 @@
   GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
   SPDX-License-Identifier: GPL-3.0-or-later
 
-.. _ansible_collections.community.general.docsite.guide_iocage:
+{% for i in examples %}
+{{ i.description }}
 
-************
-Iocage Guide
-************
+.. code-block:: {{ i.lang }}
 
-.. toctree::
-   :maxdepth: 1
+  {{ lookup('file', i.file) | split('\n') | reject('match', '^(#|---)') | join ('\n') | indent(2) }}
 
-   guide_iocage_inventory
+{% endfor %}

docs/docsite/helper/lists_mergeby/extra-vars.yml

@@ -2,5 +2,6 @@
 # Copyright (c) Ansible Project
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
-
-openjdk_pkg: java-21-openjdk-headless
+examples_one: true
+examples_all: true
+merging_lists_of_dictionaries: true

docs/docsite/helper/lists_mergeby/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst.j2

@@ -0,0 +1,74 @@
+..
+  Copyright (c) Ansible Project
+  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+Merging lists of dictionaries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you have two or more lists of dictionaries and want to combine them into a list of merged dictionaries, where the dictionaries are merged by an attribute, you can use the :ansplugin:`community.general.lists_mergeby <community.general.lists_mergeby#filter>` filter.
+
+.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See the documentation for the :ansplugin:`community.general.yaml callback plugin <community.general.yaml#callback>`.
+
+Let us use the lists below in the following examples:
+
+.. code-block:: yaml
+
+  {{ lookup('file', 'default-common.yml') | split('\n') | reject('match', '^(#|---)') | join ('\n')  | indent(2) }}
+
+{% for i in examples[0:2] %}
+{% if i.title | d('', true) | length > 0 %}
+{{ i.title }}
+{{ "%s" % ('"' * i.title|length) }}
+{% endif %}
+{{ i.description }}
+
+.. code-block:: {{ i.lang }}
+
+  {{ lookup('file', i.file) | split('\n') | reject('match', '^(#|---)') | join ('\n') | indent(2) }}
+
+{% endfor %}
+
+.. versionadded:: 2.0.0
+
+{% for i in examples[2:6] %}
+{% if i.title | d('', true) | length > 0 %}
+{{ i.title }}
+{{ "%s" % ('"' * i.title|length) }}
+{% endif %}
+{{ i.description }}
+
+.. code-block:: {{ i.lang }}
+
+  {{ lookup('file', i.file) | split('\n') | reject('match', '^(#|---)') | join ('\n') | indent(2) }}
+
+{% endfor %}
+
+The filter also accepts two optional parameters: :ansopt:`community.general.lists_mergeby#filter:recursive` and :ansopt:`community.general.lists_mergeby#filter:list_merge`. This is available since community.general 4.4.0.
+
+**recursive**
+    Is a boolean, default to ``false``. Should the :ansplugin:`community.general.lists_mergeby#filter` filter recursively merge nested hashes. Note: It does not depend on the value of the ``hash_behaviour`` setting in ``ansible.cfg``.
+
+**list_merge**
+    Is a string, its possible values are :ansval:`replace` (default), :ansval:`keep`, :ansval:`append`, :ansval:`prepend`, :ansval:`append_rp` or :ansval:`prepend_rp`. It modifies the behaviour of :ansplugin:`community.general.lists_mergeby#filter` when the hashes to merge contain arrays/lists.
+
+The examples below set :ansopt:`community.general.lists_mergeby#filter:recursive=true` and display the differences among all six options of :ansopt:`community.general.lists_mergeby#filter:list_merge`. Functionality of the parameters is exactly the same as in the filter :ansplugin:`ansible.builtin.combine#filter`. See :ref:`Combining hashes/dictionaries <combine_filter>` to learn details about these options.
+
+Let us use the lists below in the following examples
+
+.. code-block:: yaml
+
+  {{ lookup('file', 'default-recursive-true.yml') | split('\n') | reject('match', '^(#|---)') | join ('\n') |indent(2) }}
+
+{% for i in examples[6:] %}
+{% if i.title | d('', true) | length > 0 %}
+{{ i.title }}
+{{ "%s" % ('"' * i.title|length) }}
+{% endif %}
+{{ i.description }}
+
+.. code-block:: {{ i.lang }}
+
+  {{ lookup('file', i.file) | split('\n') | reject('match', '^(#|---)') | join ('\n') |indent(2) }}
+
+{% endfor %}

docs/docsite/helper/lists_mergeby/list3.out.j2

@@ -0,0 +1,7 @@
+{#
+Copyright (c) Ansible Project
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later
+#}
+list3:
+  {{ list3 | to_yaml(indent=2, sort_keys=false) | indent(2) }}

docs/docsite/helper/lists_mergeby/playbook.yml

@@ -0,0 +1,64 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# 1) Run all examples and create example-XXX.out
+# shell> ansible-playbook playbook.yml -e examples_one=true
+#
+# 2) Optionally, for testing, create examples_all.rst
+# shell> ansible-playbook playbook.yml -e examples_all=true
+#
+# 3) Create docs REST files
+# shell> ansible-playbook playbook.yml -e merging_lists_of_dictionaries=true
+#
+# Notes:
+# * Use YAML callback, e.g. set ANSIBLE_STDOUT_CALLBACK=community.general.yaml
+# * Use sphinx-view to render and review the REST files
+#   shell> sphinx-view <path_to_helper>/examples_all.rst
+# * Proofread and copy completed docs *.rst files into the directory rst.
+# * Then delete the *.rst and *.out files from this directory. Do not
+#   add *.rst and *.out in this directory to the version control.
+#
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# community.general/docs/docsite/helper/lists_mergeby/playbook.yml
+
+- hosts: localhost
+  gather_facts: false
+  tasks:
+
+    - block:
+        - import_tasks: example-001.yml
+          tags: t001
+        - import_tasks: example-002.yml
+          tags: t002
+        - import_tasks: example-003.yml
+          tags: t003
+        - import_tasks: example-004.yml
+          tags: t004
+        - import_tasks: example-005.yml
+          tags: t005
+        - import_tasks: example-006.yml
+          tags: t006
+        - import_tasks: example-007.yml
+          tags: t007
+        - import_tasks: example-008.yml
+          tags: t008
+        - import_tasks: example-009.yml
+          tags: t009
+      when: examples_one | d(false) | bool
+
+    - block:
+        - include_vars: examples.yml
+        - template:
+            src: examples_all.rst.j2
+            dest: examples_all.rst
+      when: examples_all | d(false) | bool
+
+    - block:
+        - include_vars: examples.yml
+        - template:
+            src: filter_guide_abstract_informations_merging_lists_of_dictionaries.rst.j2
+            dest: filter_guide_abstract_informations_merging_lists_of_dictionaries.rst
+      when: merging_lists_of_dictionaries | d(false) | bool

docs/docsite/helper/remove_keys/README.md

@@ -0,0 +1,61 @@
+<!--
+Copyright (c) Ansible Project
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
+
+# Docs helper. Create RST file.
+
+The playbook `playbook.yml` writes a RST file that can be used in
+docs/docsite/rst. The usage of this helper is recommended but not
+mandatory. You can stop reading here and update the RST file manually
+if you don't want to use this helper.
+
+## Run the playbook
+
+If you want to generate the RST file by this helper fit the variables
+in the playbook and the template to your needs. Then, run the play
+
+```sh
+shell> ansible-playbook playbook.yml
+```
+
+## Copy RST to docs/docsite/rst
+
+Copy the RST file to `docs/docsite/rst` and remove it from this
+directory.
+
+## Update the checksums
+
+Substitute the variables and run the below commands
+
+```sh
+shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
+shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
+```
+
+## Playbook explained
+
+The playbook includes the variable *tests* from the integration tests
+and creates the RST file from the template. The playbook will
+terminate if:
+
+* The file with the variable *tests* was changed
+* The RST file was changed
+
+This means that this helper is probably not up to date.
+
+### The file with the variable *tests* was changed
+
+This means that somebody updated the integration tests. Review the
+changes and update the template if needed. Update the checksum to pass
+the integrity test. The playbook message provides you with the
+command.
+
+### The RST file was changed
+
+This means that somebody updated the RST file manually. Review the
+changes and update the template. Update the checksum to pass the
+integrity test. The playbook message provides you with the
+command. Make sure that the updated template will create identical RST
+file. Only then apply your changes.

docs/docsite/helper/remove_keys/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst.j2

@@ -0,0 +1,80 @@
+..
+  Copyright (c) Ansible Project
+  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+remove_keys
+"""""""""""
+
+Use the filter :ansplugin:`community.general.remove_keys#filter` if you have a list of dictionaries and want to remove certain keys.
+
+.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
+
+
+Let us use the below list in the following examples:
+
+.. code-block:: yaml
+
+   input:
+     {{ tests.0.input | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[0:1]|subelements('group') %}
+* {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1
+
+   target: {{ i.1.tt }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}
+
+gives
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.0.result | to_yaml(indent=2) | indent(5) }}
+ 
+.. versionadded:: 9.1.0
+
+* The results of the below examples 1-5 are all the same:
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.1.result | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[1:2]|subelements('group') %}
+{{ loop.index }}. {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1,2
+
+   mp: {{ i.1.mp }}
+   target: {{ i.1.tt }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}
+
+* The results of the below examples 6-9 are all the same:
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.2.result | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[2:3]|subelements('group') %}
+{{ loop.index + 5 }}. {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1,2
+
+   mp: {{ i.1.mp }}
+   target: {{ i.1.tt }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}

docs/docsite/helper/remove_keys/playbook.yml

@@ -0,0 +1,79 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# Create docs REST files
+# shell> ansible-playbook playbook.yml
+#
+# Proofread and copy created *.rst file into the directory
+# docs/docsite/rst. Do not add *.rst in this directory to the version
+# control.
+#
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# community.general/docs/docsite/helper/remove_keys/playbook.yml
+
+- name: Create RST file for docs/docsite/rst
+  hosts: localhost
+  gather_facts: false
+
+  vars:
+
+    plugin: remove_keys
+    plugin_type: filter
+    docs_path:
+      - filter_guide
+      - abstract_informations
+      - lists_of_dictionaries
+
+    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
+    file_rst: ../../rst/{{ file_base }}.rst
+    file_sha1: "{{ plugin }}.rst.sha1"
+
+    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
+    target_vars: "{{ target }}/vars/main/tests.yml"
+    target_sha1: tests.yml.sha1
+
+  tasks:
+
+    - name: Test integrity tests.yml
+      when:
+        - integrity | d(true) | bool
+        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
+      block:
+
+        - name: Changed tests.yml
+          ansible.builtin.debug:
+            msg: |
+              Changed {{ target_vars }}
+              Review the changes and update {{ target_sha1 }}
+              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
+
+        - name: Changed tests.yml end host
+          ansible.builtin.meta: end_play
+
+    - name: Test integrity RST file
+      when:
+        - integrity | d(true) | bool
+        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
+      block:
+
+        - name: Changed RST file
+          ansible.builtin.debug:
+            msg: |
+              Changed {{ file_rst }}
+              Review the changes and update {{ file_sha1 }}
+              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
+
+        - name: Changed RST file end host
+          ansible.builtin.meta: end_play
+
+    - name: Include target vars
+      include_vars:
+        file: "{{ target_vars }}"
+
+    - name: Create RST file
+      ansible.builtin.template:
+        src: "{{ file_base }}.rst.j2"
+        dest: "{{ file_base }}.rst"

docs/docsite/helper/remove_keys/remove_keys.rst.sha1

@@ -0,0 +1 @@
+3cc606b42e3d450cf6323f25930f7c5a591fa086  ../../rst/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst

docs/docsite/helper/remove_keys/remove_keys.rst.sha1.license

@@ -1,3 +1,3 @@
-Copyright (c) 2025, Felix Fontein <felix@fontein.de>
+Copyright (c) Ansible Project
 GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 SPDX-License-Identifier: GPL-3.0-or-later

docs/docsite/helper/remove_keys/tests.yml.sha1

@@ -0,0 +1 @@
+0554335045f02d8c37b824355b0cf86864cee9a5  ../../../../tests/integration/targets/filter_remove_keys/vars/main/tests.yml

docs/docsite/helper/remove_keys/tests.yml.sha1.license

@@ -1,3 +1,3 @@
-Copyright (c) 2025, Felix Fontein <felix@fontein.de>
+Copyright (c) Ansible Project
 GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 SPDX-License-Identifier: GPL-3.0-or-later

docs/docsite/helper/replace_keys/README.md

@@ -0,0 +1,61 @@
+<!--
+Copyright (c) Ansible Project
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
+
+# Docs helper. Create RST file.
+
+The playbook `playbook.yml` writes a RST file that can be used in
+docs/docsite/rst. The usage of this helper is recommended but not
+mandatory. You can stop reading here and update the RST file manually
+if you don't want to use this helper.
+
+## Run the playbook
+
+If you want to generate the RST file by this helper fit the variables
+in the playbook and the template to your needs. Then, run the play
+
+```sh
+shell> ansible-playbook playbook.yml
+```
+
+## Copy RST to docs/docsite/rst
+
+Copy the RST file to `docs/docsite/rst` and remove it from this
+directory.
+
+## Update the checksums
+
+Substitute the variables and run the below commands
+
+```sh
+shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
+shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
+```
+
+## Playbook explained
+
+The playbook includes the variable *tests* from the integration tests
+and creates the RST file from the template. The playbook will
+terminate if:
+
+* The file with the variable *tests* was changed
+* The RST file was changed
+
+This means that this helper is probably not up to date.
+
+### The file with the variable *tests* was changed
+
+This means that somebody updated the integration tests. Review the
+changes and update the template if needed. Update the checksum to pass
+the integrity test. The playbook message provides you with the
+command.
+
+### The RST file was changed
+
+This means that somebody updated the RST file manually. Review the
+changes and update the template. Update the checksum to pass the
+integrity test. The playbook message provides you with the
+command. Make sure that the updated template will create identical RST
+file. Only then apply your changes.

docs/docsite/helper/replace_keys/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst.j2

@@ -0,0 +1,110 @@
+..
+  Copyright (c) Ansible Project
+  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+replace_keys
+""""""""""""
+
+Use the filter :ansplugin:`community.general.replace_keys#filter` if you have a list of dictionaries and want to replace certain keys.
+
+.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
+
+
+Let us use the below list in the following examples:
+
+.. code-block:: yaml
+
+   input:
+     {{ tests.0.input | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[0:1]|subelements('group') %}
+* {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1-3
+
+   target:
+     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}
+
+gives
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.0.result | to_yaml(indent=2) | indent(5) }}
+ 
+.. versionadded:: 9.1.0
+
+* The results of the below examples 1-3 are all the same:
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.1.result | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[1:2]|subelements('group') %}
+{{ loop.index }}. {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1-4
+
+   mp: {{ i.1.mp }}
+   target:
+     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}
+
+* The results of the below examples 4-5 are the same:
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ tests.2.result | to_yaml(indent=2) | indent(5) }}
+
+{% for i in tests[2:3]|subelements('group') %}
+{{ loop.index + 3 }}. {{ i.1.d }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1-3
+
+   mp: {{ i.1.mp }}
+   target:
+     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+{% endfor %}
+
+{% for i in tests[3:4]|subelements('group') %}
+{{ loop.index + 5 }}. {{ i.1.d }}
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   input:
+     {{ i.0.input | to_yaml(indent=2) | indent(5) }}
+
+.. code-block:: yaml+jinja
+   :emphasize-lines: 1-4
+
+   mp: {{ i.1.mp }}
+   target:
+     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
+   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
+
+gives
+
+.. code-block:: yaml
+   :emphasize-lines: 1-
+
+   result:
+     {{ i.0.result | to_yaml(indent=2) | indent(5) }}
+
+{% endfor %}

docs/docsite/helper/replace_keys/playbook.yml

@@ -0,0 +1,79 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# Create docs REST files
+# shell> ansible-playbook playbook.yml
+#
+# Proofread and copy created *.rst file into the directory
+# docs/docsite/rst. Do not add *.rst in this directory to the version
+# control.
+#
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# community.general/docs/docsite/helper/replace_keys/playbook.yml
+
+- name: Create RST file for docs/docsite/rst
+  hosts: localhost
+  gather_facts: false
+
+  vars:
+
+    plugin: replace_keys
+    plugin_type: filter
+    docs_path:
+      - filter_guide
+      - abstract_informations
+      - lists_of_dictionaries
+
+    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
+    file_rst: ../../rst/{{ file_base }}.rst
+    file_sha1: "{{ plugin }}.rst.sha1"
+
+    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
+    target_vars: "{{ target }}/vars/main/tests.yml"
+    target_sha1: tests.yml.sha1
+
+  tasks:
+
+    - name: Test integrity tests.yml
+      when:
+        - integrity | d(true) | bool
+        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
+      block:
+
+        - name: Changed tests.yml
+          ansible.builtin.debug:
+            msg: |
+              Changed {{ target_vars }}
+              Review the changes and update {{ target_sha1 }}
+              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
+
+        - name: Changed tests.yml end host
+          ansible.builtin.meta: end_play
+
+    - name: Test integrity RST file
+      when:
+        - integrity | d(true) | bool
+        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
+      block:
+
+        - name: Changed RST file
+          ansible.builtin.debug:
+            msg: |
+              Changed {{ file_rst }}
+              Review the changes and update {{ file_sha1 }}
+              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
+
+        - name: Changed RST file end host
+          ansible.builtin.meta: end_play
+
+    - name: Include target vars
+      include_vars:
+        file: "{{ target_vars }}"
+
+    - name: Create RST file
+      ansible.builtin.template:
+        src: "{{ file_base }}.rst.j2"
+        dest: "{{ file_base }}.rst"

docs/docsite/helper/replace_keys/replace_keys.rst.sha1

@@ -0,0 +1 @@
+403f23c02ac02b1c3b611cb14f9b3ba59dc3f587  ../../rst/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst

docs/docsite/helper/replace_keys/replace_keys.rst.sha1.license

@@ -0,0 +1,3 @@
+Copyright (c) Ansible Project
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later

docs/docsite/helper/replace_keys/tests.yml.sha1

@@ -0,0 +1 @@
+2e54f3528c95cca746d5748f1ed7ada56ad0890e  ../../../../tests/integration/targets/filter_replace_keys/vars/main/tests.yml

docs/docsite/helper/replace_keys/tests.yml.sha1.license

@@ -0,0 +1,3 @@
+Copyright (c) Ansible Project
+GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+SPDX-License-Identifier: GPL-3.0-or-later

docs/docsite/reformat-yaml.py

@@ -1,26 +0,0 @@
-#!/usr/bin/env python
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-import sys
-from io import StringIO
-
-from ruamel.yaml import YAML
-
-
-def main() -> None:
-    yaml = YAML(typ='rt')
-    yaml.indent(mapping=2, sequence=4, offset=2)
-
-    # Load
-    data = yaml.load(sys.stdin)
-
-    # Dump
-    sio = StringIO()
-    yaml.dump(data, sio)
-    print(sio.getvalue().rstrip('\n'))
-
-
-if __name__ == "__main__":
-    main()

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst

@@ -13,34 +13,6 @@ Use the filter :ansplugin:`community.general.keep_keys#filter` if you have a lis
 
 Let us use the below list in the following examples:
 
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
 .. code-block:: yaml
 
    input:
@@ -65,48 +37,24 @@ Let us use the below list in the following examples:
 
 gives
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - k0_x0: A0
-       k1_x1: B0
-     - k0_x0: A1
-       k1_x1: B1
-
+     - {k0_x0: A0, k1_x1: B0}
+     - {k0_x0: A1, k1_x1: B1}
 
+ 
 .. versionadded:: 9.1.0
 
 * The results of the below examples 1-5 are all the same:
 
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: ['k0_x0', 'k1_x1']
-              result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - k0_x0: A0
-       k1_x1: B0
-     - k0_x0: A1
-       k1_x1: B1
+     - {k0_x0: A0, k1_x1: B0}
+     - {k0_x0: A1, k1_x1: B1}
 
 
 1. Match keys that equal any of the items in the target.
@@ -157,28 +105,12 @@ gives
 
 * The results of the below examples 6-9 are all the same:
 
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: k0_x0
-              result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - k0_x0: A0
-     - k0_x0: A1
+     - {k0_x0: A0}
+     - {k0_x0: A1}
 
 
 6. Match keys that equal the target.
@@ -216,3 +148,4 @@ gives
    mp: regex
    target: ^.*0_x.*$
    result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
+

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst

@@ -13,34 +13,6 @@ Use the filter :ansplugin:`community.general.remove_keys#filter` if you have a l
 
 Let us use the below list in the following examples:
 
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
 .. code-block:: yaml
 
    input:
@@ -65,51 +37,27 @@ Let us use the below list in the following examples:
 
 gives
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - k2_x2:
-         - C0
+     - k2_x2: [C0]
        k3_x3: foo
-     - k2_x2:
-         - C1
+     - k2_x2: [C1]
        k3_x3: bar
 
-
+ 
 .. versionadded:: 9.1.0
 
 * The results of the below examples 1-5 are all the same:
 
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: ['k0_x0', 'k1_x1']
-              result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - k2_x2:
-         - C0
+     - k2_x2: [C0]
        k3_x3: foo
-     - k2_x2:
-         - C1
+     - k2_x2: [C1]
        k3_x3: bar
 
 
@@ -161,33 +109,15 @@ gives
 
 * The results of the below examples 6-9 are all the same:
 
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: k0_x0
-              result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
      - k1_x1: B0
-       k2_x2:
-         - C0
+       k2_x2: [C0]
        k3_x3: foo
      - k1_x1: B1
-       k2_x2:
-         - C1
+       k2_x2: [C1]
        k3_x3: bar
 
 
@@ -226,3 +156,4 @@ gives
    mp: regex
    target: ^.*0_x.*$
    result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
+

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst

@@ -13,34 +13,6 @@ Use the filter :ansplugin:`community.general.replace_keys#filter` if you have a
 
 Let us use the below list in the following examples:
 
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
 .. code-block:: yaml
 
    input:
@@ -68,61 +40,35 @@ Let us use the below list in the following examples:
 
 gives
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
      - a0: A0
        a1: B0
-       k2_x2:
-         - C0
+       k2_x2: [C0]
        k3_x3: foo
      - a0: A1
        a1: B1
-       k2_x2:
-         - C1
+       k2_x2: [C1]
        k3_x3: bar
 
-
+ 
 .. versionadded:: 9.1.0
 
 * The results of the below examples 1-3 are all the same:
 
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: starts_with
-              target:
-                - {after: a0, before: k0}
-                - {after: a1, before: k1}
-              result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
      - a0: A0
        a1: B0
-       k2_x2:
-         - C0
+       k2_x2: [C0]
        k3_x3: foo
      - a0: A1
        a1: B1
-       k2_x2:
-         - C1
+       k2_x2: [C1]
        k3_x3: bar
 
 
@@ -165,29 +111,12 @@ gives
 
 * The results of the below examples 4-5 are the same:
 
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: regex
-              target:
-                - {after: X, before: ^.*_x.*$}
-              result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - X: foo
-     - X: bar
+     - {X: foo}
+     - {X: bar}
 
 
 4. If more keys match the same attribute before the last one will be used.
@@ -216,11 +145,6 @@ gives
 
 6. If there are more matches for a key the first one will be used.
 
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
@@ -241,17 +165,11 @@ gives
 
 gives
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
    :emphasize-lines: 1-
 
    result:
-     - X: A
-       bbb1: B
-       ccc1: C
-     - X: D
-       bbb2: E
-       ccc2: F
+     - {X: A, bbb1: B, ccc1: C}
+     - {X: D, bbb2: E, ccc2: F}
+
+

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries.rst

@@ -4,7 +4,7 @@
   SPDX-License-Identifier: GPL-3.0-or-later
 
 .. _ansible_collections.community.general.docsite.filter_guide.filter_guide_abstract_informations.lists_of_dicts:
-
+  
 Lists of dictionaries
 ^^^^^^^^^^^^^^^^^^^^^
 

docs/docsite/rst/filter_guide.rst

@@ -8,7 +8,7 @@
 community.general Filter Guide
 ==============================
 
-The :anscollection:`community.general collection <community.general#collection>` offers several useful filter plugins.
+The :ref:`community.general collection <plugins_in_community.general>` offers several useful filter plugins.
 
 .. toctree::
    :maxdepth: 2

docs/docsite/rst/filter_guide_abstract_informations_counting_elements_in_sequence.rst

@@ -20,17 +20,6 @@ The :ansplugin:`community.general.counter filter plugin <community.general.count
 
 This produces:
 
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
 .. code-block:: ansible-output
 
     TASK [Count character occurrences in a string] ********************************************
@@ -83,20 +72,9 @@ This plugin is useful for selecting resources based on current allocation:
 
 This produces:
 
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
 .. code-block:: ansible-output
 
-    TASK [Get ID of SCSI controller(s) with less than 4 disks attached and choose the one with the least disks] ***
+    TASK [Get ID of SCSI controller(s) with less than 4 disks attached and choose the one with the least disks]
     ok: [localhost] => {
         "msg": "scsi_2"
     }

docs/docsite/rst/filter_guide_abstract_informations_dictionaries.rst

@@ -26,32 +26,21 @@ You can use the :ansplugin:`community.general.dict_kv filter <community.general.
           type: host
           database: all
         myservers:
-          - server1
-          - server2
+        - server1
+        - server2
 
 This produces:
 
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
 .. code-block:: ansible-output
 
-    TASK [Create a single-entry dictionary] ***************************************************
+    TASK [Create a single-entry dictionary]  **************************************************
     ok: [localhost] => {
         "msg": {
             "thatsmyvar": "myvalue"
         }
     }
 
-    TASK [Create a list of dictionaries where the 'server' field is taken from a list] ********
+    TASK [Create a list of dictionaries where the 'server' field is taken from a list]  *******
     ok: [localhost] => {
         "msg": [
             {
@@ -98,20 +87,9 @@ If you need to convert a list of key-value pairs to a dictionary, you can use th
 
 This produces:
 
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
 .. code-block:: ansible-output
 
-    TASK [Create a dictionary with the dict function] *****************************************
+    TASK [Create a dictionary with the dict function]  ****************************************
     ok: [localhost] => {
         "msg": {
             "1": 2,
@@ -119,7 +97,7 @@ This produces:
         }
     }
 
-    TASK [Create a dictionary with the community.general.dict filter] *************************
+    TASK [Create a dictionary with the community.general.dict filter]  ************************
     ok: [localhost] => {
         "msg": {
             "1": 2,
@@ -127,7 +105,7 @@ This produces:
         }
     }
 
-    TASK [Create a list of dictionaries with map and the community.general.dict filter] *******
+    TASK [Create a list of dictionaries with map and the community.general.dict filter]  ******
     ok: [localhost] => {
         "msg": [
             {

docs/docsite/rst/filter_guide_abstract_informations_grouping.rst

@@ -22,49 +22,6 @@ One example is ``ansible_facts.mounts``, which is a list of dictionaries where e
 
 This produces:
 
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    skip_first_lines: 3  # the set_fact task
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - ansible.builtin.set_fact:
-              ansible_facts:
-                mounts:
-                  - block_available: 2000
-                    block_size: 4096
-                    block_total: 2345
-                    block_used: 345
-                    device: "/dev/sda1"
-                    fstype: "ext4"
-                    inode_available: 500
-                    inode_total: 512
-                    inode_used: 12
-                    mount: "/boot"
-                    options: "rw,relatime,data=ordered"
-                    size_available: 56821
-                    size_total: 543210
-                    uuid: "ab31cade-d9c1-484d-8482-8a4cbee5241a"
-                  - block_available: 1234
-                    block_size: 4096
-                    block_total: 12345
-                    block_used: 11111
-                    device: "/dev/sda2"
-                    fstype: "ext4"
-                    inode_available: 1111
-                    inode_total: 1234
-                    inode_used: 123
-                    mount: "/"
-                    options: "rw,relatime"
-                    size_available: 42143
-                    size_total: 543210
-                    uuid: "abcdef01-2345-6789-0abc-def012345678"
-          @{{ task | indent(4) }}@
-
 .. code-block:: ansible-output
 
     TASK [Output mount facts grouped by device name] ******************************************
@@ -122,7 +79,7 @@ This produces:
                 "options": "rw,relatime",
                 "size_available": 42143,
                 "size_total": 543210,
-                "uuid": "abcdef01-2345-6789-0abc-def012345678"
+                "uuid": "bdf50b7d-4859-40af-8665-c637ee7a7808"
             },
             "/boot": {
                 "block_available": 2000,

docs/docsite/rst/filter_guide_abstract_informations_lists_helper.rst

@@ -21,34 +21,6 @@ These filters preserve the item order, eliminate duplicates and are an extended
 
 Let us use the lists below in the following examples:
 
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
 .. code-block:: yaml
 
   A: [9, 5, 7, 1, 9, 4, 10, 5, 9, 7]
@@ -63,22 +35,9 @@ The union of ``A`` and ``B`` can be written as:
 
 This statement produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
-  result:
-    - 9
-    - 5
-    - 7
-    - 1
-    - 4
-    - 10
-    - 2
-    - 8
-    - 3
+  result: [9, 5, 7, 1, 4, 10, 2, 8, 3]
 
 If you want to calculate the intersection of ``A``, ``B`` and ``C``, you can use the following statement:
 
@@ -100,14 +59,9 @@ or
 
 All three statements are equivalent and give:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
-  result:
-    - 1
+  result: [1]
 
 .. note:: Be aware that in most cases, filter calls without any argument require ``flatten=true``, otherwise the input is returned as result. The reason for this is, that the input is considered as a variable argument and is wrapped by an additional outer list. ``flatten=true`` ensures that this list is removed before the input is processed by the filter logic.
 
@@ -121,14 +75,7 @@ For example, the symmetric difference of ``A``, ``B`` and ``C`` may be written a
 
 This gives:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
-  result:
-    - 5
-    - 8
-    - 3
-    - 1
+  result: [5, 8, 3, 1]
+

docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst

@@ -12,34 +12,6 @@ If you have two or more lists of dictionaries and want to combine them into a li
 
 Let us use the lists below in the following examples:
 
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: list3
-
 .. code-block:: yaml
 
   list1:
@@ -62,22 +34,13 @@ In the example below the lists are merged by the attribute ``name``:
 
 This produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
-    - extra: false
-      name: bar
-    - name: baz
-      path: /baz
-    - extra: true
-      name: foo
-      path: /foo
-    - extra: true
-      name: meh
+    - {name: bar, extra: false}
+    - {name: baz, path: /baz}
+    - {name: foo, extra: true, path: /foo}
+    - {name: meh, extra: true}
 
 
 .. versionadded:: 2.0.0
@@ -93,22 +56,13 @@ It is possible to use a list of lists as an input of the filter:
 
 This produces the same result as in the previous example:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
-    - extra: false
-      name: bar
-    - name: baz
-      path: /baz
-    - extra: true
-      name: foo
-      path: /foo
-    - extra: true
-      name: meh
+    - {name: bar, extra: false}
+    - {name: baz, path: /baz}
+    - {name: foo, extra: true, path: /foo}
+    - {name: meh, extra: true}
 
 Single list
 """""""""""
@@ -121,22 +75,13 @@ It is possible to merge single list:
 
 This produces the same result as in the previous example:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
-    - extra: false
-      name: bar
-    - name: baz
-      path: /baz
-    - extra: true
-      name: foo
-      path: /foo
-    - extra: true
-      name: meh
+    - {name: bar, extra: false}
+    - {name: baz, path: /baz}
+    - {name: foo, extra: true, path: /foo}
+    - {name: meh, extra: true}
 
 
 The filter also accepts two optional parameters: :ansopt:`community.general.lists_mergeby#filter:recursive` and :ansopt:`community.general.lists_mergeby#filter:list_merge`. This is available since community.general 4.4.0.
@@ -151,11 +96,6 @@ The examples below set :ansopt:`community.general.lists_mergeby#filter:recursive
 
 Let us use the lists below in the following examples
 
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-
 .. code-block:: yaml
 
   list1:
@@ -188,25 +128,17 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=replace` (def
 
 This produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
-        list:
-          - patch_value
         x: default_value
         y: patch_value
+        list: [patch_value]
         z: patch_value
     - name: myname02
-      param01:
-        - 3
-        - 4
-        - 4
+      param01: [3, 4, 4]
 
 list_merge=keep
 """""""""""""""
@@ -221,26 +153,17 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=keep`:
 
 This produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
-        list:
-          - default_value
         x: default_value
         y: patch_value
+        list: [default_value]
         z: patch_value
     - name: myname02
-      param01:
-        - 1
-        - 1
-        - 2
-        - 3
+      param01: [1, 1, 2, 3]
 
 list_merge=append
 """""""""""""""""
@@ -255,30 +178,17 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append`:
 
 This produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
-        list:
-          - default_value
-          - patch_value
         x: default_value
         y: patch_value
+        list: [default_value, patch_value]
         z: patch_value
     - name: myname02
-      param01:
-        - 1
-        - 1
-        - 2
-        - 3
-        - 3
-        - 4
-        - 4
+      param01: [1, 1, 2, 3, 3, 4, 4]
 
 list_merge=prepend
 """"""""""""""""""
@@ -293,30 +203,17 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend`:
 
 This produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
-        list:
-          - patch_value
-          - default_value
         x: default_value
         y: patch_value
+        list: [patch_value, default_value]
         z: patch_value
     - name: myname02
-      param01:
-        - 3
-        - 4
-        - 4
-        - 1
-        - 1
-        - 2
-        - 3
+      param01: [3, 4, 4, 1, 1, 2, 3]
 
 list_merge=append_rp
 """"""""""""""""""""
@@ -331,29 +228,17 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append_rp`:
 
 This produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
-        list:
-          - default_value
-          - patch_value
         x: default_value
         y: patch_value
+        list: [default_value, patch_value]
         z: patch_value
     - name: myname02
-      param01:
-        - 1
-        - 1
-        - 2
-        - 3
-        - 4
-        - 4
+      param01: [1, 1, 2, 3, 4, 4]
 
 list_merge=prepend_rp
 """""""""""""""""""""
@@ -368,26 +253,15 @@ Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend_rp`:
 
 This produces:
 
-.. ansible-output-data::
-
-    playbook: ~
-
 .. code-block:: yaml
 
   list3:
     - name: myname01
       param01:
-        list:
-          - patch_value
-          - default_value
         x: default_value
         y: patch_value
+        list: [patch_value, default_value]
         z: patch_value
     - name: myname02
-      param01:
-        - 3
-        - 4
-        - 4
-        - 1
-        - 1
-        - 2
+      param01: [3, 4, 4, 1, 1, 2]
+