backport workflow updates from 1.3+ in... (#603)

Author: nickboldt

.github/pull_request_template.md

@@ -2,6 +2,8 @@
 
 <!--- If your changes apply to the latest released and/or in-development version of RHDH, open your PR against the `main` branch and cherrypick your PR to any released branches that you want to apply your changes to. --->
 
+**IMPORTANT: Do Not Merge - To be merged by Docs Team Only**
+
 **Version(s):**
 <!--- Specify the version(s) of RHDH that your PR applies to. -->
 
@@ -15,6 +17,7 @@
 - [ ] SME: @ mention assignee
 - [ ] QE: @ mention assignee
 - [ ] Docs review: @ mention assignee
+- [ ] Additional review: @mention assignee (by writer)
 <!--- SME approval is required to merge a PR unless the changes are made by a subject matter expert. --->
 <!--- QE approval is required to merge a PR unless there are no technical changes to the content. --->
 <!--- Docs team approval is required for ALL PRs. --->

.github/workflows/build-asciidoc.yml

@@ -21,6 +21,7 @@ on:
     - main
     - rhdh-1.**
     - 1.**.x
+    - release-1.**
 
 jobs:
   adoc_build:
@@ -75,11 +76,11 @@ jobs:
           PR_JSON=$(curl -sSL -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $GITHUB_TOKEN" "$PULL_URL/$PR")
           if [[ $(echo "$PR_JSON" | grep merged\") == *"merged\": true"* ]]; then
             echo "merged, can delete from pulls.html and remove folder $d"
-            git rm -fr --quiet $d || rm -fr $d
+            git rm -fr --quiet "pr-${d}" || rm -fr "pr-${d}"
             sed -r -e "/pr-$PR\/index.html>pr-$PR</d" -i pulls.html
           elif [[ $(echo "$PR_JSON" | grep \"state\") == *"state\": \"closed\""* ]]; then
-            echo "closed, can delete from pulls.html and remove folder $d"
-            git rm -fr --quiet $d || rm -fr $d
+            echo "closed, can delete from pulls.html and remove folder pr-${d}"
+            git rm -fr --quiet "pr-${d}" || rm -fr "pr-${d}"
             sed -r -e "/pr-$PR\/index.html>pr-$PR</d" -i pulls.html
           else
             echo "PR is not closed or merged (or could not read API)"

.github/workflows/pr.yml

@@ -27,6 +27,7 @@ on:
     - main
     - rhdh-1.**
     - 1.**.x
+    - release-1.**
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.number || github.event.pull_request.head.ref }}
@@ -76,6 +77,10 @@ jobs:
           echo "Building PR ${{ github.event.pull_request.number }}"
           build/scripts/build.sh -b "pr-${{ github.event.number }}"
 
+      - name: Pull from origin before pushing (if possible)
+        run: |
+          /usr/bin/git pull origin gh-pages || true
+
       # repo must be public for this to work
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4
@@ -86,14 +91,19 @@ jobs:
           keep_files: true
           publish_dir: ./titles-generated
 
-      - name: PR comment with doc preview
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.RHDH_BOT_TOKEN }}
-          script: |
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: 'PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-${{ github.event.number }}/' 
-            });
+      - name: PR comment with doc preview, replacing existing comments with a new one each time
+        shell: bash
+        env:
+          GH_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
+        run: |
+          PR_NUM="${{ github.event.number }}"
+          ORG_REPO="${{ github.repository_owner }}/${{ github.event.repository.name }}"
+          gh repo set-default "${ORG_REPO}"
+          # for a given PR, check for existing comments from rhdh-bot; select the last one (if more than one)
+          if [[ $(gh api "repos/${ORG_REPO}/issues/${PR_NUM}/comments" -q 'map(select(.user.login=="rhdh-bot"))|last|.id') ]]; then 
+            # edit that comment:
+            gh pr comment ${PR_NUM} -R "${ORG_REPO}" --edit-last --body "Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-${PR_NUM}/ @ $(date "+%x %X")"
+          else
+            # or create a new one:
+            gh pr comment ${PR_NUM} -R "${ORG_REPO}" --body "Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-${PR_NUM}/"
+          fi