Skip to content

Commit

Permalink
ci: add GitHub action to generate and deploy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisalley committed Dec 27, 2024
1 parent f0c787a commit 65a78b2
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/docs.yml
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

0 comments on commit 65a78b2

Please sign in to comment.