Skip to content

Merge pull request #44 from getzep/update-version-to-rc.1 #29

Merge pull request #44 from getzep/update-version-to-rc.1

Merge pull request #44 from getzep/update-version-to-rc.1 #29

Workflow file for this run

name: documentation
on:
workflow_dispatch:
push:
branches:
- main
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3
- name: Use Node.js 20
uses: actions/setup-node@v3
with:
node-version: 20
cache: 'yarn'
- name: Install Dependencies
run: yarn install --frozen-lockfile
- name: Build Project
run: yarn build
- name: Install TypeDoc
run: yarn add typedoc typedoc-plugin-markdown
- name: Generate Documentation
run: npx typedoc --out docs --excludePrivate --excludeInternal --excludeExternals src/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs