-
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 65a78b2
Showing
1 changed file
with
55 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,55 @@ | ||
# Simple workflow for deploying static content to GitHub Pages | ||
name: Docs | ||
on: [push] | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
jobs: | ||
# Single deploy job since we're just deploying | ||
deploy: | ||
name: Deploy Documentation | ||
|
||
# Deploy to the github-pages environment | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
# Specify runner + deployment step | ||
runs-on: ubuntu-latest | ||
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: TSDoc Action | ||
uses: erikyo/tsdoc-action@v1 | ||
with: | ||
source_dir: ./src/index.ts | ||
output_dir: ./docs | ||
front_page: README.md | ||
|
||
- name: Setup Pages | ||
uses: actions/configure-pages@v3 | ||
|
||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
# Upload entire repository | ||
path: './docs' | ||
|
||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 |