Skip to content

docs: make "branch off main" the explicit first step of adding a hook #9

docs: make "branch off main" the explicit first step of adding a hook

docs: make "branch off main" the explicit first step of adding a hook #9

Workflow file for this run

name: Docs
on:
push:
branches: [main]
workflow_dispatch:
# Grant the token what it needs to publish to GitHub Pages.
permissions:
contents: read
pages: write
id-token: write
# One deployment at a time; don't cancel an in-progress one.
concurrency:
group: pages
cancel-in-progress: false
env:
LEFTHOOK: '0'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- name: Install pnpm
uses: pnpm/action-setup@v6
- name: Set up Node
uses: actions/setup-node@v6
with:
node-version: 24
cache: pnpm
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Build API docs (TypeDoc)
run: pnpm run docs:build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v5
with:
path: docs/api
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5