-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: add GitHub action to generate and deploy docs
- Loading branch information
1 parent
f0c787a
commit b4107ff
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Simple workflow for deploying static content to GitHub Pages | ||
name: Docs | ||
on: [push] | ||
|
||
jobs: | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v4 | ||
|
||
- name: Install pnpm package manager | ||
uses: pnpm/action-setup@v4 | ||
with: | ||
version: 9.10.0 | ||
|
||
- name: Use Node ${{ matrix.node }} | ||
uses: actions/setup-node@v4 | ||
with: | ||
cache: 'pnpm' | ||
|
||
- name: Install Dependencies | ||
run: pnpm install | ||
|
||
- name: Install TypeDoc | ||
run: pnpm -g install typedoc | ||
|
||
- name: Generate docs | ||
run: typedoc src/index.ts | ||
|
||
- name: Setup Pages | ||
uses: actions/configure-pages@v5 | ||
|
||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: './docs' | ||
# - name: Deploy to GitHub Pages | ||
# id: deployment | ||
# uses: actions/deploy-pages@v4 | ||
|
||
- name: Deploy docs | ||
uses: peaceiris/actions-gh-pages@v4 | ||
if: github.ref == 'refs/heads/tsdoc-github-action' | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./docs |