docs.yml

name: docs

on:
  # Trigger deployment on every push to main branch
  push:
    branches: [main]
  # Trigger deployment manually
  workflow_dispatch:

jobs:
  docs:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
        with:
          # Fetch all commits to get latest updated time or other git log info
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v1
        with:
          # Choose Node.js version to use
          node-version: "16"

      # Cache node_modules
      #- name: Cache dependencies
      #  uses: actions/cache@v2
      #  id: yarn-cache
      #  with:
      #    path: |
      #      **/node_modules
      #    key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
      #    restore-keys: |
      #      ${{ runner.os }}-yarn-

      # Delete node_modules
      - name: Delete node_modules
        run: rm -rf node_modules

      # Install dependencies if the cache did not hit
      - name: Install dependencies
        #if: steps.yarn-cache.outputs.cache-hit != 'true'
        run: npm install

      # Run build script
      - name: Build VuePress site
        run: npm run docs:build

      # Run info command
      - name: Get VuePress info
        run: npx vuepress info

      # Deploy to GitHub Pages
      - name: Deploy to GitHub Pages
        uses: crazy-max/ghaction-github-pages@v2
        with:
          # Deploy to GH-Pages branch
          target_branch: gh-pages
          # Deploy the default output dir of VuePress
          build_dir: docs/.vuepress/dist
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}