Add staging deployment to docs.staging.cryptomator.org

Author: tobihagemann

.github/workflows/deploy.yml

@@ -2,7 +2,7 @@ name: Deploy to GitHub Pages
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main", "develop"]
   workflow_dispatch:
 
 jobs:
@@ -22,25 +22,61 @@ jobs:
           cache: 'npm'
       - name: Install dependencies
         run: npm ci
-      - name: Build with Docusaurus
+      - name: Build production
         run: npm run build
-      - name: Upload artifact
+      - name: Upload Prod Pages artifact
         uses: actions/upload-pages-artifact@v3
         with:
+          name: prod-site
+          path: './build'
+      - name: Build staging
+        run: npm run build
+        env:
+          SITE_URL: https://docs.staging.cryptomator.org
+      - name: Add robots.txt for staging
+        run: 'echo -e "User-agent: *\nDisallow: /" > build/robots.txt'
+      - name: Upload Staging artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: staging-site
           path: './build'
 
-  # DEPLOY
-  deploy:
-    name: Deploy to GitHub Pages
+  # DEPLOY PROD
+  deploy-prod:
+    if: github.ref == 'refs/heads/main'
+    name: Deploy Prod to GitHub Pages
     runs-on: ubuntu-latest
     needs: [build]
-    permissions: # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
-      pages: write      # to deploy to Pages
-      id-token: write   # to verify the deployment originates from an appropriate source
+    permissions:
+      pages: write
+      id-token: write
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
-    environment: # Deploy to the github-pages environment
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: prod-site
+    environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
+
+  # DEPLOY STAGING
+  deploy-staging:
+    if: github.ref == 'refs/heads/develop'
+    name: Deploy Staging to GitHub Pages
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - name: Download build
+        uses: actions/download-artifact@v4
+        with:
+          name: staging-site
+          path: ./public
+      - name: Deploy to Staging Repository
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          personal_token: ${{ secrets.CRYPTOBOT_DEPLOY_STAGING_DOCS }}
+          external_repository: cryptomator/docs-staging
+          publish_dir: ./public
+          publish_branch: main
+          cname: docs.staging.cryptomator.org

docusaurus.config.ts

@@ -14,7 +14,7 @@ const config: Config = {
     v4: true, // Improve compatibility with the upcoming Docusaurus v4
   },
 
-  url: 'https://docs.cryptomator.org',
+  url: process.env.SITE_URL || 'https://docs.cryptomator.org',
   baseUrl: '/',
 
   // GitHub pages deployment config.
@@ -62,8 +62,8 @@ const config: Config = {
       tagName: 'script',
       attributes: {
         src: 'https://umami.skymatic.de/script.js',
-        'data-website-id': process.env.NODE_ENV === 'development' 
-          ? 'cdd42f46-583d-4463-9ab2-8adcfe989c21' // Local development
+        'data-website-id': process.env.NODE_ENV === 'development' || process.env.SITE_URL
+          ? 'cdd42f46-583d-4463-9ab2-8adcfe989c21' // Local development / Staging
           : '2df416f9-7a9c-4e58-9a45-7106f7e0a139', // Production
         integrity: 'sha384-6PHtXKae10+dZuA/fcmjkSTDco+NPBE5fZ4eS/Em2lVIsS6FdDZIgs06MBJLEcSW',
         crossorigin: 'anonymous',