adding pnpm

.github/workflows/deploy-docs.yml

@@ -1,45 +1,51 @@
-
-name: Deploy Docs
+name: docs
 
 on:
+  # trigger deployment on every push to main branch
   push:
-    branches:
-      # make sure this is the branch you are using
-      - main
-
-permissions:
-  contents: write
+    branches: [main]
+  # trigger deployment manually
+  workflow_dispatch:
 
 jobs:
-  deploy-gh-pages:
+  docs:
     runs-on: ubuntu-latest
+
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
+          # fetch all commits to get last updated time or other git log info
           fetch-depth: 0
-          # if your docs needs submodules, uncomment the following line
-          # submodules: true
-
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          # choose pnpm version to use
+          version: 8
+          # install deps with pnpm
+          run_install: true
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
+          # choose node.js version to use
           node-version: 20
-          cache: npm
-
-      - name: Install Deps
-        run: npm ci
+          # cache deps for pnpm
+          cache: pnpm
 
-      - name: Build Docs
-        env:
-          NODE_OPTIONS: --max_old_space_size=8192
-        run: npm run docs:build
+      # run build script
+      - name: Build VuePress site
+        run: pnpm docs:build
 
-      - name: Deploy Docs
-        uses: JamesIves/github-pages-deploy-action@v4
+      # please check out the docs of the workflow for more details
+      # @see https://github.com/crazy-max/ghaction-github-pages
+      - name: Deploy to GitHub Pages
+        uses: crazy-max/ghaction-github-pages@v4
         with:
-          # This is the branch where the docs are deployed to
-          branch: gh-pages
-          folder: dist
+          # deploy to gh-pages branch
+          target_branch: gh-pages
+          # deploy the default output dir of VuePress
+          build_dir: docs/.vuepress/dist
+        env:
+          # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}