Add preview PR deployments

Signed-off-by: Nelo-T. Wallus <[email protected]>
Signed-off-by: Nelo-T. Wallus <[email protected]>

Author: ntnn

.github/workflows/pages.yaml

@@ -7,18 +7,29 @@ on:
   pull_request:
     branches:
       - main
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
   workflow_dispatch:
 
 permissions:
   contents: read
 
+env:
+  PAGES_BASE: ${{ github.event_name == 'pull_request' && format('/pages-preview-{0}', github.event.pull_request.number) || '/' }}
+
 concurrency:
-  group: pages
+  # set separate concurrency groups for main and PR branches
+  group: ${{ github.event_name == 'pull_request' && format('pages-preview-{0}', github.event.pull_request.number) || 'pages-main' }}
   cancel-in-progress: false
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    # only build on main or if the PR is open
+    if:  github.ref == 'refs/heads/main' || (github.event_name == 'pull_request' && github.event.action != 'closed')
     steps:
       - uses: actions/checkout@v5
         with:
@@ -35,16 +46,20 @@ jobs:
           path: .vitepress/dist
 
   deploy:
-    if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }}
     permissions:
       pages: write
       id-token: write
     environment:
       name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+      url: ${{ steps.deployment.outputs.page_url }} + ${{ env.PAGES_BASE }}
     needs: build
     runs-on: ubuntu-latest
     name: deploy
     steps:
       - id: deployment
         uses: actions/deploy-pages@v4
+      - uses: thollander/actions-comment-pull-request@v3
+        if: github.event_name == 'pull_request'
+        with:
+          message: |
+            A preview has been deployed to ${{ steps.deployment.outputs.page_url }} + ${{ env.PAGES_BASE }}

.vitepress/config.mts

@@ -5,6 +5,7 @@ import { fileURLToPath, URL } from 'node:url'
 export default withMermaid({
   title: "Platform Mesh",
 
+  base: process.env.PAGES_BASE ? process.env.PAGES_BASE : '/',
 
   description: "Platform Mesh - Building upon the Kubernetes API & Resource Model",
 
@@ -41,7 +42,6 @@ export default withMermaid({
       width: 24,
       height: 24
     },
-  
 
     outline: [2, 3, 4, 5],
 
@@ -63,7 +63,7 @@ export default withMermaid({
             ]
         }
       ],
-      
+
         '/scenarios': {
             test: 'Scenarios',
             items:  [
@@ -72,13 +72,11 @@ export default withMermaid({
             ],
         },
 
-
     },
-  
 
     socialLinks: [
       { icon: 'github', link: 'https://github.com/platform-mesh' }
     ]
   },
- 
+
 })