update problematic doc workflow settings and jobs

ansible-collections · Aug 7, 2024 · 8d30bf3 · 8d30bf3
1 parent 4089cda
commit 8d30bf3
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 34 deletions.
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
@@ -4,7 +4,7 @@ concurrency:
   group: docs-${{ github.head_ref }}
   cancel-in-progress: true
 on:
-  pull_request_target:
+  pull_request:
     types: [opened, synchronize, reopened, closed]
 
 env:
@@ -19,54 +19,58 @@ jobs:
     with:
       init-lenient: false
       init-fail-on-error: true
+      artifact-name: ${{ github.event.repository.name }}_docs_${{ github.event.pull_request.head.sha }}_validate
       intersphinx-links: |
         ansible_devel:https://docs.ansible.com/ansible-core/devel/
 
-
   build-docs:
     permissions:
       contents: read
     name: Build Ansible Docs
     uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
     with:
+      artifact-name: ${{ github.event.repository.name }}_docs_${{ github.event.pull_request.head.sha }}_build
       init-lenient: true
       init-fail-on-error: false
       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 }}
diff --git a/.github/workflows/docs-push.yml b/.github/workflows/docs-push.yml
@@ -1,5 +1,5 @@
 ---
-name: Collection Docs
+name: Publish Collection Docs
 concurrency:
   group: docs-push-${{ github.sha }}
   cancel-in-progress: true
@@ -9,9 +9,9 @@ on:
       - main
       - stable-*
     tags:
-      - '*'
+      - "*"
   schedule:
-    - cron: '0 12 * * *'
+    - cron: "0 12 * * *"
 
 jobs:
   build-docs:
@@ -27,13 +27,14 @@ jobs:
 
   publish-docs-gh-pages:
     # use to prevent running on forks
-    if: github.repository == 'ansible-collections/amazon.aws'
+    if: github.repository == 'ansible-collections/vmware.vmware_rest'
     permissions:
       contents: write
     needs: [build-docs]
     name: Publish Ansible Docs
     uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-publish-gh-pages.yml@main
     with:
       artifact-name: ${{ needs.build-docs.outputs.artifact-name }}
+      publish-gh-pages-branch: true
     secrets:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}