mirror of
https://github.com/norandom/OpenUltraSAST.git
synced 2026-10-16 11:49:28 +00:00
A Docs workflow builds the site strictly with the docs extra and deploys it to https://norandom.github.io/OpenUltraSAST/ on pushes to main that touch the docs. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01EmM1j46qgKMh3zqD1QMwEo
44 lines
1007 B
YAML
44 lines
1007 B
YAML
name: Docs
|
|
|
|
# Builds the MkDocs site and publishes it to GitHub Pages on every push to main that touches it.
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths: ["docs/**", "mkdocs.yml", "README.md", ".github/workflows/docs.yml"]
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
concurrency:
|
|
group: pages
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
- uses: astral-sh/setup-uv@v7
|
|
with:
|
|
enable-cache: true
|
|
- uses: actions/setup-python@v6
|
|
with:
|
|
python-version-file: .python-version
|
|
- run: uv sync --extra docs
|
|
- run: uv run mkdocs build --strict
|
|
- uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: site
|
|
deploy:
|
|
needs: build
|
|
runs-on: ubuntu-latest
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
steps:
|
|
- id: deployment
|
|
uses: actions/deploy-pages@v4
|