66 lines
2 KiB
YAML
66 lines
2 KiB
YAML
|
# Sample workflow for building and deploying a VitePress site to GitHub Pages
|
||
|
|
#
|
||
|
|
name: Deploy VitePress site to 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: [main]
|
||
|
|
|
||
|
|
# 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:
|
||
|
|
name: Build static site
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
- name: Checkout
|
||
|
|
uses: actions/checkout@v4
|
||
|
|
with:
|
||
|
|
fetch-depth: 0 # Not needed if lastUpdated is not enabled
|
||
|
|
# - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
|
||
|
|
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
|
||
|
|
- name: Setup Node
|
||
|
|
uses: actions/setup-node@v4
|
||
|
|
with:
|
||
|
|
node-version: 20
|
||
|
|
cache: npm # or pnpm / yarn
|
||
|
|
- name: Setup Pages
|
||
|
|
uses: actions/configure-pages@v4
|
||
|
|
- name: Install dependencies
|
||
|
|
run: npm ci # or pnpm install / yarn install / bun install
|
||
|
|
- name: Build with VitePress
|
||
|
|
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
|
||
|
|
- name: Upload artifact
|
||
|
|
uses: actions/upload-pages-artifact@v3
|
||
|
|
with:
|
||
|
|
path: .vitepress/dist
|
||
|
|
|
||
|
|
# Deployment job
|
||
|
|
deploy:
|
||
|
|
environment:
|
||
|
|
name: github-pages
|
||
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
||
|
|
needs: build
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
name: Deploy to Github Pages
|
||
|
|
steps:
|
||
|
|
- name: Deploy to GitHub Pages
|
||
|
|
id: deployment
|
||
|
|
uses: actions/deploy-pages@v4
|