feat: switch to rossjrw/pr-preview-action

Author: AritraDey-Dev

.github/workflows/publish-docs.yml

@@ -4,25 +4,25 @@ on:
   push:
     branches: [master]
   pull_request:
-    branches: [master]
-  workflow_dispatch:
-    inputs:
-      pr_number:
-        description: 'PR number to deploy preview for'
-        required: true
-        type: number
-      run_id:
-        description: 'Run ID of the build workflow (from the PR checks)'
-        required: true
-        type: string
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
 
 permissions:
   contents: write
   pull-requests: write
 
+concurrency: preview-${{ github.ref }}
+
+env:
+  PREVIEW_BRANCH: gh-pages-pr-previews
+
 jobs:
-  build:
+  deploy-preview:
     runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -32,59 +32,68 @@ jobs:
         with:
           node-version: 20
 
-      - name: Install dependencies
-        run: npm ci
+      - name: Install and Build
+        run: npm ci && npm run build
 
-      - name: Build
-        run: npm run build
+      - name: Deploy Preview
+        uses: rossjrw/pr-preview-action@v1
+        id: preview-step
+        with:
+          source-dir: build/
+          preview-branch: ${{ env.PREVIEW_BRANCH }}
+          comment: false
 
-      - name: Upload build artifact
-        uses: actions/upload-artifact@v4
+      - name: Comment Preview URL (Success)
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'deploy' && env.deployment_status == 'success'
         with:
-          name: site
-          path: build/
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            | <p></p> :rocket: View preview at <br> ${{ steps.preview-step.outputs.preview-url }} <br><br>
+            | <h6>Built to branch [`${{ env.PREVIEW_BRANCH }}`](${{ github.server_url }}/${{ github.repository }}/tree/${{ env.PREVIEW_BRANCH }}) at ${{ steps.preview-step.outputs.action-start-time }}. <br> Preview will be ready when the [GitHub Pages deployment](${{ github.server_url }}/${{ github.repository }}/deployments) is complete. <br><br> </h6>
+
+      - name: Comment Preview Removed
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'remove' && env.deployment_status == 'success'
+        with:
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            Preview removed because the pull request was closed.
+            ${{ steps.preview-step.outputs.action-start-time }}
 
-  deploy-pr-preview:
-    if: ${{ github.event_name == 'workflow_dispatch' }}
+  build-production:
     runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Download build artifact
-        uses: actions/download-artifact@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          name: site
-          path: site
-          run-id: ${{ inputs.run_id }}
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          node-version: 20
 
-      - name: Deploy PR Preview
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          branch: gh-pages-pr-previews
-          folder: site
-          target-folder: pr-${{ inputs.pr_number }}
+      - name: Install dependencies
+        run: npm ci
 
-      - name: Comment Preview URL
-        uses: marocchino/sticky-pull-request-comment@v2
-        with:
-          recreate: true
-          number: ${{ inputs.pr_number }}
-          message: |
-            🚀 **Preview Ready!**
-            Your docs preview for this PR is available here:
+      - name: Build
+        run: npm run build
 
-            **https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-${{ inputs.pr_number }}/**
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: site
+          path: build/
 
   deploy-production:
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
     runs-on: ubuntu-latest
-    needs: build
+    needs: build-production
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
       - name: Download build artifact
         uses: actions/download-artifact@v4
         with: