Skip to content

Commit 93d7f03

Browse files
committed
ci: Automatically build documentation
1 parent 4e98c72 commit 93d7f03

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

.github/workflows/docs.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy documentation website
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+
- name: Setup Node
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: "24"
28+
cache: pnpm
29+
- name: Prepare build
30+
run: pnpm nuxt-module-build build --stub
31+
- name: Restore cache
32+
uses: actions/cache@v4
33+
with:
34+
path: |
35+
dist
36+
.nuxt
37+
docs/dist
38+
docs/.nuxt
39+
key: ${{ runner.os }}-docs-${{ hashFiles('dist') }}
40+
restore-keys: |
41+
${{ runner.os }}-docs-
42+
- name: Install dependencies
43+
run: pnpm install
44+
- name: Generate static html
45+
run: cd docs && pnpm run generate
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: ./docs/dist
50+
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

0 commit comments

Comments
 (0)