Merge pull request #19 from alpinebuster/dev

Tweaking `deploy-docs.yml`.

Author: alpinebuster

.github/workflows/deploy-docs.yml

@@ -1,4 +1,4 @@
-# REF: `https://jaimestill.github.io/docusaur-gh/deploy`
+# REF: `https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions`
 name: Deploy Docusaurus to GitHub Pages
 
 on:
@@ -10,29 +10,48 @@ on:
 
 defaults:
   run:
-    working-directory: docs
+    shell: bash
+    working-directory: ./docs
 
 jobs:
-  deploy:
-    name: Build Docusaurus to gh-pages
+  build:
+    name: Build Docusaurus
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
         with:
-          node-version: 22
+          node-version: 18
           cache: npm
-          cache-dependency-path: docs/package-lock.json
 
-      - name: Install dependencies
+      - name: Install Dependencies
         run: npm ci
-      - name: Build website
+      - name: Build Website
         run: npm run build
 
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/build
-          user_name: github-actions[bot]
-          user_email: 41898282+github-actions[bot]@users.noreply.github.com
+          path: 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

docs/README.md

@@ -37,7 +37,9 @@ USE_SSH=true npm run deploy
 Not using SSH:
 
 ```bash
-GIT_USER=<Your GitHub username> npm run deploy
+git credential-cache exit
+
+GIT_USER=<github_username> GITHUB_TOKEN=<token> npm run deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.