Skip to content

docs: replace runtime dlp-profiles refs with runtime dlp profiles (#230) #80

docs: replace runtime dlp-profiles refs with runtime dlp profiles (#230)

docs: replace runtime dlp-profiles refs with runtime dlp profiles (#230) #80

Workflow file for this run

name: Deploy Docs
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- "scripts/**"
- "src/**"
- "typedoc.json"
- "package.json"
- ".github/workflows/mkdocs-deploy.yml"
workflow_dispatch:
env:
# Run JS actions (upload-pages-artifact/deploy-pages) on Node 24 — no newer major yet.
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: 'true'
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v5
with:
node-version: 24
cache: pnpm
- run: pnpm install --frozen-lockfile
- uses: actions/setup-python@v6
with:
python-version: "3.11"
- run: pip install -r docs/requirements.txt
- name: Generate CLI + API reference
run: |
pnpm docs:gen
pnpm docs:api
- name: Build docs
run: mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4