Skip to content

docs: Enhance API Reference - Documentation improvements (#410) #24

docs: Enhance API Reference - Documentation improvements (#410)

docs: Enhance API Reference - Documentation improvements (#410) #24

name: Deploy TypeDoc on GitHub pages
on:
push:
branches:
develop
env:
NODE_VERSION: 18.x
ENTRY_FILE: 'packages'
CONFIG_PATH: 'tsconfig.base.json'
USES_PNPM: 'true'
jobs:
deploy:
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
node-version: ${{ env.NODE_VERSION }}
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 7
- name: Install dependencies
run: pnpm install --no-frozen-lockfile
- name: Build project
run: pnpm build
- name: Build documentation
run: pnpm docs:generate
- name: Deploy to GitHub pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs
clean: true