Skip to content

Workflow file for this run

name: Deploy VitePress site to Pages
on:
push:
branches: [master]
paths:
- "docs/**"
- ".github/workflows/docs_site_build.yml"
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
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
- uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: bun i # or pnpm install / yarn install / bun install
working-directory: docs
- name: Build with VitePress
run: |
bun run docs:build
touch ./.vitepress/dist/.nojekyll
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