Skip to content

Workflow file for this run

name: Generate Documentation
on:
# Runs on pushes targeting the default branch
push:
branches: [ "master" ]
paths:
- "**.ts"
# 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:
deploy:
name: "Deploy Documentation to Pages"
if: "!contains(github.event.head_commit.message, '[ci skip]')"
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
- name: Build
run: |
npm install
npx typedoc src/index.ts
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload output directory
path: "./docs"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1