docs site: add PR previews

.github/workflows/deploy-docs-and-extensions.yml

@@ -4,14 +4,14 @@ on:
   push:
     branches:
       - main
-
-  pull_request:
     paths:
       - 'documentation/**'
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
 
     steps:
       - name: Checkout the branch
@@ -47,10 +47,9 @@ jobs:
           mkdir -p combined-build/v1/extensions
           cp -r extensions-site/build/client/* combined-build/v1/extensions/
 
-      - name: Deploy to /gh-pages
-        uses: peaceiris/actions-gh-pages@v3
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: combined-build
-          destination_dir: . # Deploy the site to the root /goose directory
-
+          clean-exclude: pr-preview/
+          folder: combined-build
+          force: false

.github/workflows/pr-website-preview.yml

@@ -0,0 +1,59 @@
+name: Documentation Site Preview
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+    paths:
+      - 'documentation/**'
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the branch
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        if: github.event.action != 'closed'
+        with:
+          node-version: 20 
+
+      - name: Install dependencies and build docs
+        working-directory: ./documentation
+        if: github.event.action != 'closed'
+        env:
+          INKEEP_API_KEY: ${{ secrets.INKEEP_API_KEY }}
+          INKEEP_INTEGRATION_ID: ${{ secrets.INKEEP_INTEGRATION_ID }}
+          INKEEP_ORG_ID: ${{ secrets.INKEEP_ORG_ID }}
+          TARGET_PATH: "/goose/pr-preview/pr-${{ github.event.number }}/"
+        run: |
+          npm install
+          npm run build
+
+      - name: Install dependencies and build extensions-site
+        working-directory: ./extensions-site
+        env:
+          VITE_BASENAME: "/goose/pr-preview/pr-${{ github.event.number }}/v1/extensions/" # Set the base URL here for the extensions site
+        run: |
+          npm install
+          npm run build
+
+      - name: Combine builds into one directory
+        run: |
+          mkdir combined-build
+          cp -r documentation/build/* combined-build/
+          mkdir -p combined-build/v1/extensions
+          cp -r extensions-site/build/client/* combined-build/v1/extensions/
+
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@v1
+        if: ${{ github.event.pull_request.head.repo.full_name == 'block/goose' }}
+        with:
+          source-dir: combined-build

documentation/docusaurus.config.ts

@@ -20,7 +20,7 @@ const config: Config = {
   url: "https://block.github.io/",
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
-  baseUrl: "/goose/",
+  baseUrl: process.env.TARGET_PATH || "/goose/",
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.