Skip to content

docs: Add docs publish workflow #17

docs: Add docs publish workflow

docs: Add docs publish workflow #17

Workflow file for this run

name: Build and publish docs
on:
pull_request:
types:
- opened
- reopened
- synchronize
- labeled
# release:
# types: [published]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: 'github-pages'
cancel-in-progress: false
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
name: Install pnpm
with:
run_install: false
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 22
cache: pnpm
- name: Install dependencies
env:
SKIP_RUST_BUILD: 1
run: pnpm install --frozen-lockfile
- name: Generate TypeDoc markdown (without modifying repo)
run: |
pnpm run build:docs
rm -rf docs-typedoc
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the built site for deployment
path: '_site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4