add a two step process

Signed-off-by: Aritra Dey <[email protected]>

Author: AritraDey-Dev

.github/workflows/publish-docs.yml

@@ -4,85 +4,95 @@ on:
   push:
     branches: [master]
   pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - closed
+    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
 
 permissions:
   contents: write
-
-concurrency: preview-${{ github.ref }}
-
-env:
-  PREVIEW_BRANCH: gh-pages
+  pull-requests: write
 
 jobs:
-  deploy-preview:
+  build:
     runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request'
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: 20
 
-      - name: Calculate BASE_URL
-        run: echo "BASE_URL=/pr-preview/pr-${{ github.event.pull_request.number }}" >> $GITHUB_ENV
+      - name: Install dependencies
+        run: npm ci
 
-      - run: npm ci && npm run build
-        env:
-          BASE_URL: ${{ env.BASE_URL }}
+      - name: Build
+        run: npm run build
 
-      - uses: rossjrw/pr-preview-action@v1
-        id: preview-step
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
         with:
-          source-dir: ./build/
-          preview-branch: ${{ env.PREVIEW_BRANCH }}
-          comment: false
+          name: site
+          path: build/
 
-      - uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.preview-step.outputs.deployment-action == 'deploy' && env.deployment_status == 'success'
+  deploy-pr-preview:
+    if: ${{ github.event_name == 'workflow_dispatch' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
         with:
-          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: site
+          path: site
+          run-id: ${{ inputs.run_id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.preview-step.outputs.deployment-action == 'remove' && env.deployment_status == 'success'
+      - name: Deploy PR Preview
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          header: pr-preview
+          branch: gh-pages-pr-previews
+          folder: site
+          target-folder: pr-${{ inputs.pr_number }}
+
+      - name: Comment Preview URL
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          recreate: true
+          number: ${{ inputs.pr_number }}
           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 }}
+            🚀 **Preview Ready!**
+            Your docs preview for this PR is available here:
 
-  build-production:
-    runs-on: ubuntu-latest
-    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with: { node-version: 20 }
-      - run: npm ci
-      - run: npm run build
-      - uses: actions/upload-artifact@v4
-        with: { name: site, path: build/ }
+            **https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-${{ inputs.pr_number }}/**
 
   deploy-production:
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
     runs-on: ubuntu-latest
-    needs: build-production
-    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    needs: build
     steps:
-      - uses: actions/download-artifact@v4
-        with: { name: site, path: site }
-      - uses: JamesIves/github-pages-deploy-action@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: site
+          path: site
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
           branch: gh-pages
-          folder: site
-          clean-exclude: pr-preview
+          folder: site

docusaurus.config.js

@@ -4,7 +4,7 @@ module.exports = {
   tagline:
     "Ecosystem science, policy, and management informed by the best available data and models",
   url: "https://pecanproject.github.io",
-  baseUrl: (process.env.GITHUB_ACTIONS && process.env.BASE_URL) ? `${process.env.BASE_URL}/` : "/",
+  baseUrl: process.env.BASE_URL || "/",
   onBrokenLinks: "ignore",
   onBrokenMarkdownLinks: "warn",
   favicon: "img/favicon.ico",