workflow

mikemorency · Aug 7, 2024 · 6100c85 · 6100c85
1 parent 96e5b74
commit 6100c85
Showing 1 changed file with 31 additions and 28 deletions.
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
@@ -35,39 +35,42 @@ jobs:
       intersphinx-links: |
         ansible_devel:https://docs.ansible.com/ansible-core/devel/
 
-  comment:
-    permissions:
-      pull-requests: write
-    runs-on: ubuntu-latest
-    needs: [build-docs]
-    name: PR comments
-    steps:
-      - name: PR comment
-        uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main
-        with:
-          body-includes: "## Docs Build"
-          reactions: heart
-          action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }}
-          on-closed-action: remove
-          on-merged-body: |
-            ## Docs Build 📝
+  # This job requires that the workflow trigger is pull_request_target. However that trigger uses
+  # whatever version of the workflow is available on main instead of the feature branch.
+  #
+  # comment:
+  #   permissions:
+  #     pull-requests: write
+  #   runs-on: ubuntu-latest
+  #   needs: [build-docs]
+  #   name: PR comments
+  #   steps:
+  #     - name: PR comment
+  #       uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main
+  #       with:
+  #         body-includes: "## Docs Build"
+  #         reactions: heart
+  #         action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }}
+  #         on-closed-action: remove
+  #         on-merged-body: |
+  #           ## Docs Build 📝
 
-            Thank you for contribution!✨
+  #           Thank you for contribution!✨
 
-            This PR has been merged and your docs changes will be incorporated when they are next published.
-          body: |
-            ## Docs Build 📝
+  #           This PR has been merged and your docs changes will be incorporated when they are next published.
+  #         body: |
+  #           ## Docs Build 📝
 
-            Thank you for contribution!✨
+  #           Thank you for contribution!✨
 
-            The docsite for **this PR** is available for download as an artifact from this run:
-            ${{ needs.build-docs.outputs.artifact-url }}
+  #           The docsite for **this PR** is available for download as an artifact from this run:
+  #           ${{ needs.build-docs.outputs.artifact-url }}
 
-            You can compare to the docs for the `main` branch here:
-            ${{ env.GHP_BASE_URL }}/branch/main
+  #           You can compare to the docs for the `main` branch here:
+  #           ${{ env.GHP_BASE_URL }}/branch/main
 
-            File changes:
+  #           File changes:
 
-            ${{ needs.build-docs.outputs.diff-files-rendered }}
+  #           ${{ needs.build-docs.outputs.diff-files-rendered }}
 
-            ${{ needs.build-docs.outputs.diff-rendered }}
+  #           ${{ needs.build-docs.outputs.diff-rendered }}