ci: remove unneeded path tricks in docs workflow (#640)

Removed unnecessary `./ansible_collections/paloaltonetworks/panos` path tricks from CI docs workflow.

Author: alperenkose

.github/workflows/ci.yml

@@ -97,6 +97,10 @@ jobs:
       run:
         working-directory: ./ansible_collections/${{ env.NAMESPACE }}/${{ env.COLLECTION_NAME }}
     steps:
+      # Just a note here:  The Ansible stuff is apparently doing realpath
+      # checks, so trying to simlink stuff and then run Ansible commands
+      # such as ansible-test in the symlink directory fails.  Thus we need
+      # to have the real path contain ansible_collections/paloaltonetworks/panos.
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
           path: ./ansible_collections/${{ env.NAMESPACE }}/${{ env.COLLECTION_NAME }}

.github/workflows/docs.yml

@@ -9,32 +9,17 @@ env:
   COLLECTION_NAME: panos
 
 jobs:
-  pyversion:
-    name: Discover minimum Python version
-    uses: ./.github/workflows/_discover_python_ver.yml
-
   docs:
     name: Build Documentation
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./ansible_collections/${{ env.NAMESPACE }}/${{ env.COLLECTION_NAME }}
 
     steps:
-      # Just a note here:  The Ansible stuff is apparently doing realpath
-      # checks, so trying to simlink stuff and then run Ansible commands
-      # such as ansible-test in the symlink directory fails.  Thus we need
-      # to have the real path contain ansible_collections/paloaltonetworks/panos.
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-        with:
-          path: ./ansible_collections/${{ env.NAMESPACE }}/${{ env.COLLECTION_NAME }}
 
       - name: discover Python version
         id: pyversion
         uses: ./.github/actions/discover_python_version
-        with:
-          working-directory: ./ansible_collections/${{ env.NAMESPACE }}/${{ env.COLLECTION_NAME }}
 
       - name: Setup Python
         uses: actions/setup-python@b64ffcaf5b410884ad320a9cfac8866006a109aa # v4
@@ -49,9 +34,6 @@ jobs:
       - name: Add ansible-core
         run: poetry add ansible-core^2.16
 
-      - name: Add antsibull-docs
-        run: poetry add antsibull-docs
-
       - name: Install dependencies
         run: poetry install
 
@@ -69,16 +51,6 @@ jobs:
           rm -rf docs/html/.doctrees
         shell: bash
 
-      # This is here for right now because the action to deploy seems to assume
-      # (and not have a configuration option to) mirror the actions/checkout@v4
-      # the with.path spec.
-      - name: Move the repo to where the deploy action is looking for it
-        run: |
-          cd ../../../..
-          mv pan-os-ansible the_repo
-          mv the_repo/ansible_collections/${{ env.NAMESPACE }}/${{ env.COLLECTION_NAME }} pan-os-ansible
-          mkdir -p pan-os-ansible/ansible_collections/${{ env.NAMESPACE }}/${{ env.COLLECTION_NAME }}
-
       - name: Deploy to GitHub Pages
         uses: JamesIves/github-pages-deploy-action@a1ea191d508feb8485aceba848389d49f80ca2dc # v4.4.3
         with:

.gitignore

@@ -92,7 +92,7 @@ docs/_diagrams
 
 tests/output/
 
-docs/html/
+# docs/html/ # this is pushed to gh-pages branch - do not push on other branches
 docs/source/_build/
 docs/source/modules/
 

Makefile

@@ -7,14 +7,20 @@
 collection := $(notdir $(realpath $(CURDIR)      ))
 namespace  := $(notdir $(realpath $(CURDIR)/..   ))
 toplevel   := $(notdir $(realpath $(CURDIR)/../..))
-
 err_msg := Place collection at <WHATEVER>/ansible_collections/paloaltonetworks/panos
-ifneq (panos,$(collection))
-  $(error $(err_msg))
-else ifneq (paloaltonetworks,$(namespace))
-  $(error $(err_msg))
-else ifneq (ansible_collections,$(toplevel))
-  $(error $(err_msg))
+
+# List of targets that require path check
+PATH_CHECK_TARGETS := old-sanity new-sanity
+
+# Check if current target requires path check
+ifneq ($(filter $(MAKECMDGOALS),$(PATH_CHECK_TARGETS)),)
+  ifneq (panos,$(collection))
+    $(error $(err_msg))
+  else ifneq (paloaltonetworks,$(namespace))
+    $(error $(err_msg))
+  else ifneq (ansible_collections,$(toplevel))
+    $(error $(err_msg))
+  endif
 endif
 
 python_version := $(shell \
@@ -32,7 +38,7 @@ docs:		## Build collection documentation
 	rm -rf docs/html
 	rm -rf docs/source/modules
 	mkdir antsibull
-	poetry run antsibull-docs collection --use-current --dest-dir antsibull --no-indexes paloaltonetworks.panos
+	antsibull-docs collection --use-current --dest-dir antsibull --no-indexes paloaltonetworks.panos
 	mkdir -p docs/source/modules
 	mv antsibull/collections/paloaltonetworks/panos/* docs/source/modules
 	rm -rf antsibull

plugins/modules/panos_security_rule.py

@@ -40,6 +40,7 @@
     - Robert Hagen (@stealthllama)
     - Michael Richardson (@mrichardson03)
     - Garfield Lee Freeman (@shinmog)
+    - Alp Eren Kose (@alperenkose)
 version_added: '1.0.0'
 requirements:
     - pandevice can be obtained from PyPI U(https://pypi.python.org/pypi/pandevice)