add a two step process

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

Author: AritraDey-Dev

.github/workflows/publish-docs.yml

@@ -4,67 +4,106 @@ on:
   push:
     branches: [master]
   pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - closed
+    types: [opened, reopened, synchronize, closed]
+  workflow_dispatch:
+    inputs:
+      pr_number:
+        description: 'PR Number'
+        required: true
+      run_id:
+        description: 'Run ID of the build artifact'
+        required: true
 
 permissions:
   contents: write
+  pull-requests: write
+  actions: read
 
-concurrency: preview-${{ github.ref }}
-
-env:
-  PREVIEW_BRANCH: gh-pages
+concurrency: ci-${{ github.ref }}
 
 jobs:
-  deploy-preview:
-    runs-on: ubuntu-latest
+  # 1. Build Preview Artifact (Runs on PR)
+  build-preview:
     if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
     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
+        run: |
+          echo "BASE_URL=/pr-preview/pr-${{ github.event.pull_request.number }}/" >> $GITHUB_ENV
 
-      - run: npm ci && npm run build
+      - name: Install and Build
+        run: npm ci && npm run build
         env:
           BASE_URL: ${{ env.BASE_URL }}
 
-      - uses: rossjrw/pr-preview-action@v1
-        id: preview-step
+      - name: Upload Preview Artifact
+        uses: actions/upload-artifact@v4
         with:
-          source-dir: ./build/
-          preview-branch: ${{ env.PREVIEW_BRANCH }}
-          comment: false
+          name: preview-build
+          path: build/
 
-      - uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.preview-step.outputs.deployment-action == 'deploy' && env.deployment_status == 'success'
+      - name: Comment Build Info
+        uses: marocchino/sticky-pull-request-comment@v2
         with:
-          header: pr-preview
+          header: pr-build-info
           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>
+            ### ✅ Build Successful
+            To deploy this preview, a maintainer must run the **Deploy Preview** workflow.
+            
+            **Run ID**: `${{ github.run_id }}`
+            **PR Number**: `${{ github.event.pull_request.number }}`
+
+  # 2. Deploy Preview (Manual Trigger)
+  deploy-preview:
+    if: github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
 
-      - uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.preview-step.outputs.deployment-action == 'remove' && env.deployment_status == 'success'
+      - name: Download 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 }}
-            :---:
-            Preview removed because the pull request was closed.
-            ${{ steps.preview-step.outputs.action-start-time }}
+          name: preview-build
+          run-id: ${{ inputs.run_id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path: site
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: site
+          target-folder: pr-preview/pr-${{ inputs.pr_number }}
 
+      - name: Comment Preview Link
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const prNumber = ${{ inputs.pr_number }};
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const url = `https://${owner}.github.io/${repo}/pr-preview/pr-${prNumber}/`;
+            
+            await github.rest.issues.createComment({
+              owner,
+              repo,
+              issue_number: prNumber,
+              body: `🚀 **Preview Deployed!**\n\n[View Preview](${url})`
+            });
+
+  # 3. Production Build & Deploy (Runs on Master Push)
   build-production:
-    runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -75,9 +114,9 @@ jobs:
         with: { name: site, path: build/ }
 
   deploy-production:
-    runs-on: ubuntu-latest
     needs: build-production
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/download-artifact@v4
         with: { name: site, path: 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",