Skip to content

feat(runtime): add gated multi-agent parallel execution #207

feat(runtime): add gated multi-agent parallel execution

feat(runtime): add gated multi-agent parallel execution #207

Workflow file for this run

name: docs
# Triggers: plugin README changes, docs source changes, or manual dispatch.
# Required repo setup: Settings → Pages → Source = "GitHub Actions" (not a branch).
on:
push:
branches: [main]
paths:
- "plugins/*/README.md"
- "docs/**"
- "mkdocs.yml"
- "pyproject.toml"
workflow_dispatch:
# Least-privilege permissions required for OIDC-based Pages deploy.
# contents:read — checkout
# pages:write — upload pages artifact
# id-token:write — request OIDC JWT for trusted deploy (no PAT needed)
permissions:
contents: read
pages: write
id-token: write
# Only one Pages deploy may run at a time.
# cancel-in-progress:false ensures an in-flight deploy is never killed mid-publish.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: 📥 Checkout documentation sources
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
with:
# Product pages include plugins/*/README.md through MkDocs snippets.
persist-credentials: false
# git-revision-date plugin requires full history
fetch-depth: 0
- name: 🐍 Set up Python 3.12
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
with:
python-version: "3.12"
# Pin to exact minor so the build is reproducible across runner updates.
- name: 📦 Install uv
uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
- name: 🧱 Install native imaging dependencies
# Material's social plugin uses CairoSVG, which needs the native Cairo
# shared library in addition to the Python package.
run: sudo apt-get update && sudo apt-get install --yes libcairo2
- name: 🏗️ Build docs (strict — warnings are errors)
# --strict turns every MkDocs warning into a build failure.
# Remove --strict only if a plugin emits unavoidable warnings.
# docs deps live in pyproject [dependency-groups] docs (source of truth).
env:
# Material for MkDocs documents this opt-out for its MkDocs 2.0 notice.
NO_MKDOCS_2_WARNING: "1"
run: uv run --only-group docs --python 3.12 mkdocs build --strict
- name: ⚙️ Configure GitHub Pages
# Injects the correct base URL into the artifact so relative links work
# regardless of whether the site lives at the apex or a /repo/ sub-path.
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4
- name: ⬆️ Upload Pages artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
# mkdocs build writes output to site/ by default (set in mkdocs.yml: site_dir).
path: site/
deploy:
needs: build
runs-on: ubuntu-latest
timeout-minutes: 5
# "github-pages" is the reserved environment name for Pages OIDC deploys.
# Must exist under Settings → Environments (created automatically by Pages setup).
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: 🚀 Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4