fix: All content updated to fit the standard for Ansible Validated Content (#13)

Author: adambaumeister

.ansible-lint.yml

@@ -9,4 +9,6 @@ skip_list:
 
 exclude_paths:
   - mkdocs.yml
+  - panos_policy_automation/mkdocs.yml
   - .github
+  - panos_policy_automation/.github

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ defaults:
 
 on:
   pull_request:
-    branches: [ master ]
+    branches: [master]
 jobs:
   ansible-syntax:
     runs-on: ubuntu-latest
@@ -16,6 +16,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4
+        with:
+          path: "ansible_collections/paloaltonetworks/panos_policy_automation"
 
       - name: Set up Python
         uses: actions/setup-python@7f4fc3e22c37d6ff65e88745f38bd3157c663f7c # v4
@@ -33,29 +35,14 @@ jobs:
 
       - name: Ansible lint
         run: |
-          ansible-lint ../ansible_panos_policy_orchestration/ --offline
-
-  python-tests:
-    runs-on: ubuntu-latest
-    name: Python Filter Tests
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4
-
-      - name: Set up Python
-        uses: actions/setup-python@7f4fc3e22c37d6ff65e88745f38bd3157c663f7c # v4
-        with:
-          python-version: "3.11"
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install pytest
+          cd ansible_collections/paloaltonetworks/panos_policy_automation
+          ls -l
+          ansible-lint . --offline
 
-      - name: Run custom filter tests
+      - name: Ansible Sanity Tests
         run: |
-          python -m pytest ./plugins/filter/test_custom_filters.py -v
+          cd ansible_collections/paloaltonetworks/panos_policy_automation
+          ansible-test sanity --exclude mkdocs.yml
 
   secrets-scan:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -56,7 +56,7 @@ jobs:
       - name: Update Ansible Galaxy file with the next version
         run: |
           sed -i 's/version\:.*/version: ${{ steps.get_version.outputs.NEXT_VERSION }}/' galaxy.yml
-    
+
       - name: Commit and push galaxy changes
         run: |
           git config --global user.name 'Github Actions Release Pipeline'
@@ -85,4 +85,4 @@ jobs:
       - name: Run semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: semantic-release
+        run: semantic-release

.releaserc.json

@@ -1,16 +1,16 @@
-{
-  "branches": ["master"],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    [
-      "@semantic-release/git",
-      {
-        "assets": ["CHANGELOG.md"],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-      }
-    ],
-    "@semantic-release/github"
-  ]
+{
+  "branches": ["master"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ]
 }

LICENSE.md

@@ -1,7 +1,7 @@
-Copyright (c) 2025 abaumeister
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright (c) 2025 abaumeister
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,8 +1,8 @@
 # Ansible PAN-OS Policy Automation
 
 ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/adambaumeister/ansible_panos_policy_orchestration)
-![GitHub commits difference between two branches/tags/commits](https://img.shields.io/github/commits-difference/adambaumeister/ansible_panos_policy_orchestration?base=master&head=develop&label=Changes%20Pending%20Release)
-![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/adambaumeister/ansible_panos_policy_orchestration/ci.yml)
+![GitHub commits difference between two branches/tags/commits](https://img.shields.io/github/commits-difference/paloaltonetworks/ansible_panos_policy_orchestration?base=master&head=develop&label=Changes%20Pending%20Release)
+![Ansible Lint/Sanity Checks](https://img.shields.io/github/actions/workflow/status/paloaltonetworks/ansible_panos_policy_orchestration/ci.yml?label=Ansible%20Lint%2FSanity%20Checks)
 ![GitHub License](https://img.shields.io/github/license/adambaumeister/ansible_panos_policy_orchestration)
 ![GitHub Repo stars](https://img.shields.io/github/stars/adambaumeister/ansible_panos_policy_orchestration)
 ![GitHub Release](https://img.shields.io/github/v/release/adambaumeister/ansible_panos_policy_orchestration)
@@ -19,22 +19,43 @@ This repository would be of interest to you if:
  * You can make repeatable, actionable policy decisions 
  * You are comfortable with Ansible or General automation platforms.
 
-## Quickstart
-
-### Requirements
+## Requirements
 
  * Python 3.11+
  * Ansible 2.16+
  * Panorama (this collection does NOT work for standalone firewalls or Strata Cloud Manager)
  * NGFWs connected to Panorama must be running Routed mode
 
-### Install this collection
+## Installation
+
+Before using this collection, you need to install it with the Ansible Galaxy command-line tool:
 
 ```shell
 ansible-galaxy install paloaltonetworks.panos_policy_automation
 ```
 
-### Define your Inventory
+You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:
+
+```yaml
+collections:
+  - name: paloaltonetworks.panos_policy_automation
+```
+
+To upgrade the collection to the latest available version, run the following command:
+
+```
+ansible-galaxy collection install paloaltonetworks.panos_policy_automation --upgrade
+```
+
+You can also install a specific version of the collection. Use the following syntax to install version 1.0.0:
+
+```
+ansible-galaxy collection install paloaltonetworks.panos_policy_automation:==1.0.0
+```
+
+See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.
+
+### Post-Installation Configuration
 
 In this example, we are defining one panorama host under "lab".
 
@@ -136,15 +157,52 @@ Note, replace the playbook and vars file names with your versions.
 ansible-playbook your_playbook.yml -i inventory.yml --extra-vars=@vars_file.yml
 ```
 
-## Need help?
+## Use Cases
+
+**Automatically updating Object Groups**
+
+Transforming requests for policy to new network objects.
+
+**Automatically creating policy at preset locations**
+
+Deploying new security rules to the bottom, top, or at a preset location such as "after this rule".
+
+## Testing
+
+This collection has been tested in lab environments with the following specs:
+
+| product         | version                   |
+|-----------------|---------------------------|
+| Panorama        | 11.2.3-h3                 |
+| vm-series       | 11.2.3-h3                 |
+| mode            | routed                    |
+| router type     | virtual (legacy, not ARE) |
+| Total Firewalls | 1                         |
+
+
+## Support
+
+For support, please raise a [Github issue](https://github.com/PaloAltoNetworks/ansible_panos_policy_orchestration/issues. This collection is supported by PaloAltoNetworks on a **best effort basis**
+only. For more detailed support, including deployment help, contact Palo Alto Networks Professional Services.
+
+## Release Notes and Roadmap
+
+View the [Releases](https://github.com/PaloAltoNetworks/ansible_panos_policy_orchestration/releases) page for a detailed
+changelog.
+
+## Related Information
 
 Read the [docs](https://paloaltonetworks.github.io/ansible_panos_policy_orchestration/) for more information.
 
+## License Information
+
+https://github.com/PaloAltoNetworks/ansible_panos_policy_orchestration/blob/master/LICENSE.md
+
 ## Responsible AI Assistance Disclosure
 
-Generative AI through the use of large language models has been used selectively in this repository
+Generative AI, through the use of large language models, has been used selectively in this repository
 in the following ways:
 
 1. Creating or editing documentation
-2. Refactoring modules
+2. Refactoring modules (such as changing parent path)
 3. Creation of unit tests

plugins/filter/panos_op_get_zone_from_interface.py

@@ -1,5 +1,3 @@
-#!/usr/bin/python
-
 DOCUMENTATION = '''
 name: panos_op_get_zone_from_interface
 short_description: Get security zone from interface names
@@ -54,7 +52,6 @@
 '''
 
 from xml.etree.ElementTree import fromstring
-from typing import Union
 
 
 def panos_op_get_zone_from_interface(data, interface_names):
@@ -79,4 +76,4 @@ class FilterModule(object):
     def filters(self):
         return {
             'panos_op_get_zone_from_interface': panos_op_get_zone_from_interface
-        }
+        }

plugins/filter/panos_op_policy_match_result_to_bool.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python
 
 DOCUMENTATION = '''
 name: panos_op_policy_match_result_to_bool
@@ -60,7 +59,6 @@
 
 import json
 from json import JSONDecodeError
-from typing import Union
 
 
 def panos_op_policy_match_result_to_bool(data):
@@ -86,4 +84,4 @@ class FilterModule(object):
     def filters(self):
         return {
             'panos_op_policy_match_result_to_bool': panos_op_policy_match_result_to_bool
-        }
+        }

plugins/filter/panos_op_routing_result_to_interfaces.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python
 
 DOCUMENTATION = '''
 name: panos_op_routing_result_to_interfaces
@@ -47,7 +46,6 @@
 '''
 
 import json
-from typing import Union
 
 
 def panos_op_routing_result_to_interfaces(results):
@@ -68,4 +66,4 @@ class FilterModule(object):
     def filters(self):
         return {
             'panos_op_routing_result_to_interfaces': panos_op_routing_result_to_interfaces
-        }
+        }

plugins/filter/panos_op_stdout_results_to_list.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python
 
 DOCUMENTATION = '''
 name: panos_op_stdout_results_to_list
@@ -41,7 +40,6 @@
 '''
 
 import json
-from typing import Union
 
 
 def panos_op_stdout_results_to_list(data):
@@ -61,4 +59,4 @@ class FilterModule(object):
     def filters(self):
         return {
             'panos_op_stdout_results_to_list': panos_op_stdout_results_to_list
-        }
+        }