Skip to content

Commit

Permalink
fix: typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
nickfrosty committed Jun 29, 2024
1 parent 3abb19e commit d152a67
Showing 1 changed file with 20 additions and 33 deletions.
53 changes: 20 additions & 33 deletions .github/workflows/typedoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,38 @@ on:
release:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
push:
branches: [main]

# 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
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./package
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- run: npm install
# Generate your TypeDoc documentation
- run: npm run deploy:docs
# https://github.com/actions/upload-pages-artifact
- uses: actions/upload-pages-artifact@v2
with:
path: ./docs # This should be your TypeDoc "out" path.
deploy:
name: Deploy Documentation

# Deploy to the github-pages environment
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 16
cache: "npm"

- name: TSDoc Action
uses: erikyo/tsdoc-action@v1
with:
source_dir: ./src/*
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
# https://github.com/actions/deploy-pages
uses: actions/deploy-pages@v2

0 comments on commit d152a67

Please sign in to comment.