documents.yml

name: documents

on:
  # run every time a push occurs in the docs folder
  push:
    branches: [master]
    paths:
      - docs/**
      - .github/workflows/documents.yml
      - package.json
      - package-lock.json
  # trigger deployment manually
  workflow_dispatch:

jobs:
  build-documentation-pages:
    runs-on: ubuntu-latest

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

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

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

      # copy changelog.md file
      - name: Copy CHANGELOG.md file
        run: |
          cp CHANGELOG.md ./docs/en/changelog.md
          cp CHANGELOG.md ./docs/ko/changelog.md
          cp CHANGELOG.md ./docs/zhHans/changelog.md

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

      # run build script
      - name: Build VitePress site
        run: npm run docs:build

      # 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:
          # deploy to gh-pages branch
          target_branch: gh-pages
          # deploy the default output dir of VitePress
          build_dir: docs-dist
          jekyll: false
          fqdn: 'vitepress-sidebar.cdget.com'
        env:
          # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}