Merge pull request #285 from CodexRaunak/add-deployment-gh-pages

Add preview deployment gh pages

Author: leecalcote

.github/workflows/build-and-deploy-site.yml

@@ -1,22 +1,47 @@
 name: Build and Deploy Site
+
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'site/**'
+      - 'Makefile'
+      - 'CNAME'
+      - '.github/workflows/build-and-deploy-site.yml'
+      - '.github/workflows/build-and-preview-site.yml'
+
+permissions:
+  contents: write
+
+defaults:
+  run:
+    shell: bash
 
 jobs:
   build-and-deploy:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@v3.5.3
-      - name: Install and Build 🔧 
+      - name: Checkout site source
+        uses: actions/checkout@v6
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+          cache-dependency-path: site/package-lock.json
+
+      - name: Install and Build
         run: |
-          make setup-libs
+          make setup
           make build
+          cp CNAME site/build/CNAME
+          touch site/build/.nojekyll
 
-      - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4.4.3
+      - name: Deploy site
+        uses: peaceiris/actions-gh-pages@v4
         with:
-          branch: site # The branch the action should deploy to.
-          folder: site/build # The folder the action should deploy.
-          clean: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./site/build
+          keep_files: true

.github/workflows/build-and-preview-site.yml

@@ -0,0 +1,96 @@
+name: Build and Preview Site
+
+on:
+  pull_request_target:
+    branches: [master]
+    types: [opened, synchronize, reopened, closed]
+    paths:
+      - '!**'
+      - 'site/**'
+      - 'Makefile'
+      - 'CNAME'
+      - '.github/workflows/build-and-preview-site.yml'
+      - '.github/workflows/build-and-deploy-site.yml'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+concurrency:
+  group: preview-${{ github.event.pull_request.number || github.run_id }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build-and-deploy-preview:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout PR code
+        if: github.event.action != 'closed'
+        uses: actions/checkout@v6
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.sha }}
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Checkout for cleanup
+        if: github.event.action == 'closed'
+        uses: actions/checkout@v6
+        with:
+          ref: gh-pages
+          fetch-depth: 0
+
+      - name: Setup Node
+        if: github.event.action != 'closed'
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+          cache-dependency-path: site/package-lock.json
+
+      - name: Install and Build PR preview
+        if: github.event.action != 'closed'
+        run: |
+          make setup
+          make build
+          touch site/build/.nojekyll
+          cat > site/build/robots.txt <<'EOF'
+          User-agent: *
+          Disallow: /
+          EOF
+          perl -0pi -e 's|<meta property="og:url" content="[^"]*" />|<meta property="og:url" content="https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.pull_request.number }}/" />|; s|</head>|    <meta name="robots" content="noindex, nofollow" />\n</head>|' site/build/index.html
+
+      - name: Deploy PR preview
+        if: github.event.action != 'closed'
+        uses: rossjrw/pr-preview-action@v1.6.3
+        with:
+          source-dir: ./site/build
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          action: auto
+          comment: false
+
+      - name: Comment PR with Preview URL
+        if: github.event.action != 'closed'
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: pr-preview
+          message: |
+            🚀 **Preview deployment for PR #${{ github.event.pull_request.number }}**
+
+            🌐 **Preview URL**: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.pull_request.number }}/
+
+            _This preview will be updated automatically when you push new commits to this PR._
+
+      - name: Cleanup PR preview on close
+        if: github.event.action == 'closed'
+        uses: rossjrw/pr-preview-action@v1.6.3
+        with:
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          action: remove