File tree Expand file tree Collapse file tree 1 file changed +55
-0
lines changed
Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Original file line number Diff line number Diff line change 1+ # Simple workflow for deploying static content to GitHub Pages
2+ name : TSDoc Actions
3+
4+ on :
5+ release :
6+ # Allows you to run this workflow manually from the Actions tab
7+ workflow_dispatch :
8+
9+ # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
10+ permissions :
11+ contents : read
12+ pages : write
13+ id-token : write
14+
15+ jobs :
16+ # Single deploy job since we're just deploying
17+ deploy :
18+ name : Deploy Documentation
19+
20+ # Deploy to the github-pages environment
21+ environment :
22+ name : github-pages
23+ url : ${{ steps.deployment.outputs.page_url }}
24+
25+ # Specify runner + deployment step
26+ runs-on : ubuntu-latest
27+ steps :
28+ - name : Checkout code
29+ uses : actions/checkout@v3
30+
31+ - name : Setup Node
32+ uses : actions/setup-node@v3
33+ with :
34+ node-version : 16
35+ cache : " npm"
36+
37+ - name : TSDoc Action
38+ uses : erikyo/tsdoc-action@v1
39+ with :
40+ source_dir : ./src/*
41+ output_dir : ./docs
42+ front_page : README.md
43+
44+ - name : Setup Pages
45+ uses : actions/configure-pages@v3
46+
47+ - name : Upload artifact
48+ uses : actions/upload-pages-artifact@v2
49+ with :
50+ # Upload entire repository
51+ path : ' ./docs'
52+
53+ - name : Deploy to GitHub Pages
54+ id : deployment
55+ uses : actions/deploy-pages@v2
You can’t perform that action at this time.
0 commit comments