deploy.yml

# REF:
#   1. https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch
name: Deploy Docs from Workflow Action
on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    if: ${{ github.event_name == 'push' }}
    steps:
      - uses: actions/checkout@v4.1.2
        with:
          ref: main
          fetch-depth: 0

      - name: Setup Node
        uses: actions/setup-node@v4.0.2
        with:
          node-version: 20

      - run: npm install
      - name: Build Static Docs
        env:
          NODE_OPTIONS: '--max_old_space_size=8192'
        run: npm run build

      - name: Upload Artifact
        uses: actions/upload-pages-artifact@v3.0.1
        with:
          path: ./.vuepress/dist

  # Deployment job
  deploy:
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write # to deploy pages
      id-token: write # to verify the originates from an appropriate source
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4.0.5