Skip to content

chore: release v0.19.0 (#138) #45

chore: release v0.19.0 (#138)

chore: release v0.19.0 (#138) #45

Workflow file for this run

name: Documentation
on:
push:
branches: [main]
paths:
- 'src/**'
- 'package.json'
- 'tsconfig.json'
- 'typedoc.json'
- 'docs/**'
- '.github/workflows/docs.yml'
pull_request:
types: [closed]
branches: [main]
paths:
- 'src/**'
- 'package.json'
- 'tsconfig.json'
- 'typedoc.json'
- 'docs/**'
- '.github/workflows/docs.yml'
jobs:
publish-docs:
# Run on push to main or when PR is merged
if: github.event_name == 'push' || github.event.pull_request.merged == true
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: 'pages'
cancel-in-progress: false
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '22'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Generate documentation
run: npm run docs
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4