-
-
Notifications
You must be signed in to change notification settings - Fork 41
78 lines (65 loc) · 1.79 KB
/
deploy-docs.yml
File metadata and controls
78 lines (65 loc) · 1.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Workflow for building and deploying a VitePress site to GitHub Pages
name: VitePress CI/CD
on:
# Run on all pushes to any branch
push:
# Also allow manual trigger
workflow_dispatch:
defaults:
run:
working-directory: src
# Sets permissions of the GITHUB_TOKEN
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: pages
cancel-in-progress: false
jobs:
# Build job - runs on all branches
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v6
with:
node-version-file: ./src/.nvmrc
- name: Install dependencies
run: npm ci
- name: Build TS
run: npm run build:ts
- name: Run linting (ESlint and Prettier)
run: npm run lint
- name: Build with VitePress
run: |
npm run docs:build
touch docs/.vitepress/dist/.nojekyll
# Upload artifact only if on main branch
- name: Setup Pages
if: github.ref == 'refs/heads/main'
uses: actions/configure-pages@v4
- name: Upload artifact
if: github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: ./src/docs/.vitepress/dist
# Deployment job - only runs if build job completes and we're on main branch
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
# Only run this job if we're on the main branch
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4