-
Notifications
You must be signed in to change notification settings - Fork 1
53 lines (43 loc) · 1.22 KB
/
deploy-docs.yml
File metadata and controls
53 lines (43 loc) · 1.22 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
name: Deploy VitePress site to Pages
on:
push:
branches: ["main"]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Recommended for VitePress "last updated" timestamps
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm' # Speeds up future runs by caching node_modules
- name: Install dependencies
run: npm install
- name: Build with TypeDoc and VitePress
# This is where you run your "perfect script"
run: npm run docs:build
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# IMPORTANT: Point this to your actual build output folder
path: 'docs/.vitepress/dist'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4