Skip to content

Commit 3f95640

Browse files
committed
ci(docs): deploy Documentation site to GitHub Pages
1 parent 008b12b commit 3f95640

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

Diff for: .github/workflows/docs.yml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy Documentation site to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0
26+
- name: Setup Node
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: 20
30+
cache: yarn
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v3
33+
- name: Install dependencies
34+
run: yarn install
35+
- name: Build with VitePress
36+
run: |
37+
yarn docs:build
38+
touch docs/.vitepress/dist/.nojekyll
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v2
41+
with:
42+
path: docs/.vitepress/dist
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
needs: build
49+
runs-on: ubuntu-latest
50+
name: Deploy
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v2

0 commit comments

Comments
 (0)