From 06b24f356e4843c5212d9bb2be880a46995fc38f Mon Sep 17 00:00:00 2001
From: carlobortolan <carlobortolan@gmail.com>
Date: Wed, 27 Nov 2024 02:51:21 +0100
Subject: [PATCH] Update GitHub Actions workflow for deploying documentation to
 GitHub Pages

---
 .github/workflows/deploy-docs.yaml | 85 +++++++++++++-----------------
 1 file changed, 37 insertions(+), 48 deletions(-)

diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
index 0eb276dbb..2d2ed242b 100644
--- a/.github/workflows/deploy-docs.yaml
+++ b/.github/workflows/deploy-docs.yaml
@@ -1,64 +1,53 @@
-name: Deploy docs to GH Pages
+name: Deploy to GitHub Pages
 
 on:
   push:
-  #    branches:
-  #      - dev
-
-  # Option to run workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-defaults:
-  run:
-    shell: bash
+    branches:
+      - enh/docs
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
 
 jobs:
-  # Build job
   build:
+    name: Build Docusaurus
     runs-on: ubuntu-latest
     steps:
-        - name: Checkout
-          uses: actions/checkout@v3
-          with:
-            submodules: recursive
-            fetch-depth: 0
-        - name: Setup Pages
-          id: pages
-          uses: actions/configure-pages@v3
-        - name: Install Node.js
-          uses: actions/setup-node@v3
-          with:
-            node-version: '18'
-        - name: Install dependencies
-          run: npm install
-          working-directory: ./docs_v2
-        - name: Build with Docusaurus
-          run: npm run build
-          working-directory: ./docs_v2
-        - name: Upload artifact
-          uses: actions/upload-pages-artifact@v1
-          with:
-            path: ./docs_v2/build
-    
-  # Deployment job
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: ./docs_v2
+      - name: Build website
+        run: yarn build
+        working-directory: ./docs_v2
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs_v2/build
+
   deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
+
     runs-on: ubuntu-latest
-    needs: build
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4
\ No newline at end of file