Skip to content

Commit

Permalink
Build and deploy documentation
Browse files Browse the repository at this point in the history
Build and deploy TypeDoc documentation whenever there is a commit to
`main`.
  • Loading branch information
elliotgoodrich committed Jul 3, 2024
1 parent bd025b0 commit a3a18fd
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Documentation

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: latest
cache: 'npm'
- run: cd configure && npm ci
- run: npm run docs
- uses: actions/upload-pages-artifact@v3
with:
path: "./docs"
deploy:
runs-on: ubuntu-latest
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit a3a18fd

Please sign in to comment.