Skip to content

Commit d788173

Browse files
Add GitHub Actions workflow to deploy docs to gh-pages
Adds a workflow with manual trigger (workflow_dispatch) that generates TypeDoc documentation and publishes it to the gh-pages branch using peaceiris/actions-gh-pages. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 2a07274 commit d788173

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
workflow_dispatch:
5+
# Future: Uncomment to auto-deploy on release
6+
# release:
7+
# types: [published]
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
deploy:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: oven-sh/setup-bun@v2
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: "20"
21+
- run: npm install
22+
- run: npm run build
23+
- run: npm run docs
24+
- uses: peaceiris/actions-gh-pages@v4
25+
with:
26+
github_token: ${{ secrets.GITHUB_TOKEN }}
27+
publish_dir: ./docs
28+
publish_branch: gh-pages
29+
force_orphan: true

0 commit comments

Comments
 (0)