Skip to content

Commit 8fa3e7f

Browse files
committedJan 30, 2023
deploy typedocs to gh pages
1 parent 62afd8b commit 8fa3e7f

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed
 

‎.github/workflows/typedoc.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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 one concurrent deployment
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: true
22+
23+
jobs:
24+
# Single deploy job since we're just deploying
25+
deploy:
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v3
33+
- name: Use Nodejs ${{ matrix.node-version }}
34+
uses: actions/setup-node@v3
35+
with:
36+
node-version: 18.x
37+
- name: Install dependencies
38+
run: npm install
39+
- name: Generate typedocs
40+
run: npm run typedoc
41+
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v3
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v1
46+
with:
47+
path: './docs'
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v1

0 commit comments

Comments
 (0)
Please sign in to comment.