Skip to content

Commit d60db08

Browse files
committed
Create docs.yml
1 parent bcf8d15 commit d60db08

File tree

2 files changed

+15825
-8738
lines changed

2 files changed

+15825
-8738
lines changed

.github/workflows/docs.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy TypeDoc to Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
# Allows you to run this workflow manually from the Actions tab
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+
deploy:
20+
environment:
21+
name: github-pages
22+
url: ${{ steps.deployment.outputs.page_url }}
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
- name: Setup Pages
28+
uses: actions/configure-pages@v5
29+
- uses: actions/setup-node@v4
30+
with:
31+
node-version: 18
32+
cache: 'yarn'
33+
- run: yarn install --immutable
34+
- name: Generate Documentations
35+
run: yarn docs
36+
- name: Upload artifact
37+
uses: actions/upload-pages-artifact@v3
38+
with:
39+
path: './docs'
40+
- name: Deploy to GitHub Pages
41+
id: deployment
42+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)