Setup pushpreview.yml (#20)

* Setup pushpreview.yml
* Fix wrong path
* Improve workflow (prevent waste of resources)
* Add name to workflows
* Dynamically adapt to different environments, particularly for preview deployments

Author: sebastienvermeille

.github/workflows/build.yml

@@ -1,9 +1,15 @@
+name: Build and check
+
 on:
   pull_request:
 
 permissions:
   contents: read
 
+concurrency:
+  group: 'build-doc-${{ github.ref }}'  # This ensures concurrency for the same branch or PR
+  cancel-in-progress: true  # This cancels any in-progress execution when a new commit is done on the same branch
+
 jobs:
   build-doc:
     name: Build documentation
@@ -17,4 +23,4 @@ jobs:
         run: yarn install --frozen-lockfile
       - name: Build documentation website
         # Check URLs are valid, path to images, etc.
-        run: cd docs && yarn build
+        run: yarn build

.github/workflows/deploy.yml

@@ -1,3 +1,5 @@
+name: Deploy
+
 on:
   push:
     branches:
@@ -34,4 +36,4 @@ jobs:
           # The GH actions bot is used by default if you didn't specify the two fields.
           # You can swap them out with your own user credentials.
           user_name: github-actions[bot]
-          user_email: 41898282+github-actions[bot]@users.noreply.github.com
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/pushpreview.yml

@@ -0,0 +1,38 @@
+# When a PR get labelled "preview", deploy a web rendering of the changes via pushpreview
+name: PushPreview
+
+on:
+  pull_request_target:
+    types:
+      - labeled
+
+jobs:
+  preview:
+    runs-on: ubuntu-24.04
+    if: github.event.label.name == 'preview'
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Comment
+        run: |
+          gh pr comment ${{ github.event.pull_request.number }} --repo ${{ github.repository }} --body "⚙️ Hang tight! PushPreview is currently building your preview. We'll share the URL as soon as it's ready."
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
+        with:
+          node-version: 18
+
+      - name: Set BASE_URL
+        run: echo "BASE_URL=/github/${{ github.repository }}/${{ github.event.number }}/" >> $GITHUB_ENV
+
+      - name: Build site
+        run: |
+          yarn install --frozen-lockfile
+          yarn build
+
+      - name: Generate preview
+        uses: TechDocsStudio/pushpreview-action@cf958f7be2bf55d3f56d351bb9abf56b4c6b9a50 # 1.0.6
+        with:
+          source-directory: ./build
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          pushpreview-token: ${{ secrets.PUSHPREVIEW_TOKEN }}

docusaurus.config.ts

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