deploy.yml

name: Deploy VitePress site to Pages

on:
    push:
        branches:
            - main
            - deploy
    # allows to run the workflow manually from the Actions tab
    workflow_dispatch:

# 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@v4
            -   name: Setup Node
                uses: actions/setup-node@v4
                with:
                    node-version: 20
                    cache: 'yarn'
            -   name: Setup Pages
                uses: actions/configure-pages@v4
            -   name: Install dependencies
                run: yarn install
            -   name: Build with VitePress
                run: yarn build
            -   name: Upload artifact
                uses: actions/upload-pages-artifact@v3
                with:
                    path: ./dist

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