Skip to content

Commit 756de58

Browse files
committed
doc: GitHub Pages
1 parent 442f089 commit 756de58

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

.github/workflows/pages.yml

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

0 commit comments

Comments
 (0)