File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Sample workflow for building and deploying a VitePress site to GitHub Pages
2+ #
3+ name : Deploy VitePress site to Pages
4+
5+ on :
6+ # Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+ # using the `master` branch as the default branch.
8+ push :
9+ branches : [main]
10+
11+ # Allows you to run this workflow manually from the Actions tab
12+ workflow_dispatch :
13+
14+ # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+ permissions :
16+ contents : read
17+ pages : write
18+ id-token : write
19+
20+ # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+ # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+ concurrency :
23+ group : pages
24+ cancel-in-progress : false
25+
26+ jobs :
27+ # Build job
28+ build :
29+ runs-on : ubuntu-latest
30+ steps :
31+ - name : Checkout
32+ uses : actions/checkout@v4
33+ with :
34+ fetch-depth : 0
35+ - name : Setup Node
36+ uses : actions/setup-node@v4
37+ with :
38+ node-version : 20
39+ - name : Install dependencies
40+ run : npm ci
41+ working-directory : docs
42+ - name : Build with VitePress
43+ run : npm run docs:build
44+ working-directory : docs
45+ - name : Upload artifact
46+ uses : actions/upload-pages-artifact@v3
47+ with :
48+ path : docs/.vitepress/dist
49+
50+ # Deployment job
51+ deploy :
52+ environment :
53+ name : github-pages
54+ url : ${{ steps.deployment.outputs.page_url }}
55+ runs-on : ubuntu-latest
56+ needs : build
57+ steps :
58+ - name : Deploy to GitHub Pages
59+ id : deployment
60+ uses : actions/deploy-pages@v4
You can’t perform that action at this time.
0 commit comments