Skip to content

fix: satisfy ruff 0.16 RUF036 and ISC004 #32

fix: satisfy ruff 0.16 RUF036 and ISC004

fix: satisfy ruff 0.16 RUF036 and ISC004 #32

Workflow file for this run

name: Docs
on:
push:
branches: [main]
paths:
- "docs/**"
- "packages/*/src/**"
- "mkdocs.yml"
- "scripts/generate_openapi_docs.py"
- ".github/workflows/docs.yml"
pull_request:
paths:
- "docs/**"
- "packages/*/src/**"
- "mkdocs.yml"
- "scripts/generate_openapi_docs.py"
- ".github/workflows/docs.yml"
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- name: Install uv
uses: astral-sh/setup-uv@v7
- name: Build docs
run: |
uv sync --all-packages --extra docs
uv run --no-sync python scripts/generate_openapi_docs.py
uv run --no-sync mkdocs build --strict
- name: Upload Pages artifact
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
uses: actions/upload-pages-artifact@v4
with:
path: site/
deploy:
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
needs: build
runs-on: ubuntu-latest
# Pages allows one deployment at a time; queue instead of failing with 400.
concurrency:
group: pages
cancel-in-progress: false
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4