# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Pages

on:
    # Runs on pushes targeting the `main` branch. Change this to `master` if you're
    # using the `master` branch as the default branch.
    push:
        branches: [ v4 ]

    # Allows you to run this workflow manually from the Actions tab
    workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
    contents: read
    pages: write
    id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
    group: pages
    cancel-in-progress: false

jobs:
    # Build job
    build:
        runs-on: ubuntu-latest
        steps:
            -   name: Checkout
                uses: actions/checkout@v3
            -   name: Setup Node
                uses: actions/setup-node@v3
                with:
                    node-version: 18
                    cache: npm
                    cache-dependency-path: docs/package-lock.json
            -   name: Setup Pages
                uses: actions/configure-pages@v3
            -   name: Install dependencies
                run: npm ci # or pnpm install / yarn install
                working-directory: docs
            -   name: Build with VitePress
                run: npm run docs:build # or pnpm docs:build / yarn docs:build
                working-directory: docs
            -   name: Upload artifact
                uses: actions/upload-pages-artifact@v2
                with:
                    path: docs/.vitepress/dist

    # Deployment job
    deploy:
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}
        needs: build
        runs-on: ubuntu-latest
        name: Deploy
        steps:
            -   name: Deploy to GitHub Pages
                id: deployment
                uses: actions/deploy-pages@v2