docs.yml

name: docs

on:
    push:
        branches:
            - main
    workflow_run:
        workflows:
            - changelog
        types:
            - completed
    workflow_dispatch:

permissions: write-all

jobs:
    generate:
        runs-on: ubuntu-latest

        steps:
            -   uses: actions/checkout@v4
                with:
                    fetch-depth: 0
                    token: ${{ secrets.GITHUB_TOKEN }}

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

            -   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-${{ hashFiles('**/package-lock.json') }}

            -   name: Install dependencies
                run: npm i

            -   name: Build VuePress site
                run: npm run build

            -   name: Deploy to GitHub Pages
                uses: crazy-max/ghaction-github-pages@v4.0.0
                with:
                    target_branch: gh-pages
                    build_dir: docs/.vuepress/dist
                env:
                    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}