Skip to content

Commit 2827cf3

Browse files
authored
doc: GitHub Pages (#38)
1 parent 442f089 commit 2827cf3

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

.github/workflows/pages.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
# Allows you to run this workflow manually from the Actions tab
8+
workflow_dispatch:
9+
10+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
17+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: false
21+
22+
jobs:
23+
# Single deploy job since we're just deploying
24+
deploy:
25+
environment:
26+
name: github-pages
27+
url: ${{ steps.deployment.outputs.page_url }}
28+
runs-on: ubuntu-latest
29+
steps:
30+
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
31+
- uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda
32+
with:
33+
run_install: false
34+
- name: Use Node.js ${{ matrix.node-version }}
35+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020
36+
with:
37+
node-version: 22
38+
cache: pnpm
39+
registry-url: 'https://registry.npmjs.org'
40+
- run: pnpm i --frozen-lockfile
41+
- run: node --run typedoc
42+
- name: Setup Pages
43+
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
46+
with:
47+
path: 'doc'
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

0 commit comments

Comments
 (0)