Skip to content

TypeDoc generation

TypeDoc generation #5

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: TypeDoc generation
on:
release:
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
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 code
uses: actions/checkout@v3
- name: TypeDoc Action
uses: erikyo/tsdoc-action@v1
with:
source_dir: ./lib/*
output_dir: ./docs
skipErrorChecking: true
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