chore: change website deploy script (#3602)

.github/workflows/deploy-website-old.yml

@@ -0,0 +1,57 @@
+name: Deploy Jekyll Website to GitHub Pages
+
+on:
+  # push:
+  #   branches:
+  #     - main
+  #   paths:
+  #     - 'docs/**'
+  #     - 'website/**'
+  #     - 'package.json'
+  # Run on demand
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build-and-deploy-website:
+    name: Build and Deploy Website
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+
+      - name: Install dependencies
+        run: |
+          npm i
+          cd website
+          npm i
+
+      - name: Build website
+        run: |
+          cd website
+          npm run build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      # cspell:ignore peaceiris
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./docs
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # 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
+          disable_nojekyll: true # cspell:ignore nojekyll

.github/workflows/deploy-website.yml

@@ -1,57 +1,57 @@
 name: Deploy Website to GitHub Pages
 
 on:
-  push:
-    branches:
-      - main
-    paths:
-      - 'docs/**'
-      - 'website/**'
-      - 'package.json'
-  # Run on demand
   workflow_dispatch:
+  # push:
+  #   branches:
+  #     - main
+  #   paths:
+  #     - 'website/**'
+  #     - 'package.json'
 
-permissions:
-  contents: read
+  # 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-and-deploy-website:
-    name: Build and Deploy Website
-    permissions:
-      contents: write
+  build:
+    name: Build Docusaurus
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-node@v4
         with:
-          node-version: 20.x
+          node-version: 20
+          cache: npm
 
       - name: Install dependencies
-        run: |
-          npm i
-          cd website
-          npm i
-
+        run: npm i
       - name: Build website
         run: |
           cd website
+          npm i
           npm run build
 
-      # Popular action to deploy to GitHub Pages:
-      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
-      # cspell:ignore peaceiris
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v4
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          # Build output to publish to the `gh-pages` branch:
-          publish_dir: ./docs
-          # The following lines assign commit authorship to the official
-          # GH-Actions bot for deploys to `gh-pages` branch:
-          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
-          # 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
-          disable_nojekyll: true # cspell:ignore nojekyll
+          path: website/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
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

website/docusaurus.config.ts

@@ -11,7 +11,7 @@ const config: Config = {
     url: 'https://streetsidesoftware.com',
     // Set the /<baseUrl>/ pathname under which your site is served
     // For GitHub pages deployment, it is often '/<projectName>/'
-    baseUrl: '/vscode-spell-checker/docsV2/',
+    baseUrl: '/vscode-spell-checker/',
 
     // GitHub pages deployment config.
     // If you aren't using GitHub pages, you don't need these.

website/package.json

@@ -6,11 +6,11 @@
     "docusaurus": "docusaurus",
     "start": "docusaurus start",
     "build": "npm run gen-docs && npm run build:docusaurus",
-    "build:docusaurus": "docusaurus build --out-dir ../docs/docsV2",
+    "build:docusaurus": "docusaurus build",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
-    "clean": "rm -rf ../docs/docsV2",
-    "clear": "docusaurus clear ../docs/docsV2 && docusaurus clear",
+    "clean": "npm run clear",
+    "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",