Skip to content

Commit

Permalink
Add GitHub workflow to deploy docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
SpacingBat3 committed Jan 28, 2025
1 parent 51de957 commit 60a8b7f
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/typedoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: latest
- name: Install dependencies
run: "npm ci"
- name: Generate documentation
run: "npm run docs"
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: './docs/api/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

0 comments on commit 60a8b7f

Please sign in to comment.