Skip to content

Commit 62e4efe

Browse files
committed
ci: deploy docs with github actions
1 parent 1d16e84 commit 62e4efe

3 files changed

Lines changed: 46 additions & 3 deletions

File tree

.github/workflows/benchmark.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@ name: Libauth Benchmarks
22
on:
33
push:
44
branches:
5-
- v2
5+
- master
66

77
permissions:
88
contents: write
99
deployments: write
1010

11+
concurrency:
12+
group: "benchmarks"
13+
cancel-in-progress: true
14+
1115
jobs:
1216
benchmark:
1317
name: Run Benchmarks

.github/workflows/doc.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Generate API Docs
2+
on:
3+
push:
4+
branches:
5+
- master
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
doc:
19+
name: Generate API Docs
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v3
23+
with:
24+
submodules: 'true'
25+
- name: Setup node
26+
uses: actions/setup-node@v3
27+
with:
28+
node-version: 18
29+
- name: Generate Docs
30+
run: yarn && yarn doc:html && yarn doc:logo && yarn doc:cname
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v3
33+
- name: Upload artifact
34+
uses: actions/upload-pages-artifact@v1
35+
with:
36+
path: 'build/docs'
37+
- name: Deploy to GitHub Pages
38+
id: github-pages
39+
uses: actions/deploy-pages@v1

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@
7575
"doc": "yarn doc:html && open-cli build/docs/index.html",
7676
"doc:logo": "cpy assets/libauth.svg build/docs",
7777
"doc:cname": "node -e \"console.log('libauth.org')\" > build/docs/CNAME",
78-
"doc:html": "typedoc src/index.ts --target ES6 --mode file --excludeNotExported --out build/docs",
79-
"doc:json": "typedoc src/index.ts --target ES6 --mode file --excludeNotExported --json build/docs/typedoc.json",
78+
"doc:html": "typedoc src/index.ts --out build/docs",
79+
"doc:json": "typedoc src/index.ts --json build/docs/typedoc.json",
8080
"doc:next": "yarn build && yarn doc:extract && yarn doc:generate",
8181
"doc:extract": "api-extractor run --local --typescript-compiler-folder node_modules/typescript",
8282
"doc:generate": "api-documenter markdown -i temp -o docs/markdown",

0 commit comments

Comments
 (0)