Max Isbey
8f308a431a
The combined GitHub Pages site now serves the current major (v2, from main) at the root and mirrors the same build under /v2/, and builds the v1 maintenance line (from v1.x) under /v1/. Per-major paths are meant to be permanent: /v2/ stays a byte-identical copy of the root so existing /v2/... links keep resolving after a future major takes the root, the way /v1/... will for v1. main becomes the sole deployer of the combined site: the deploy workflow no longer triggers on v1.x pushes, and a v1.x docs change goes live on the next main deploy or a manual workflow_dispatch. site_url and both packages' Documentation URLs point at the root as the canonical location.
67 lines
1.8 KiB
YAML
67 lines
1.8 KiB
YAML
name: Deploy Docs
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
# main is the sole deployer of the combined site (v2 at / and /v2/, v1.x
|
|
# at /v1/); the v1.x branch has no deploy workflow. A v1.x docs change is
|
|
# published by the next main deploy or a manual workflow_dispatch here.
|
|
- main
|
|
paths:
|
|
- docs/**
|
|
# docs pages include their code blocks from these files via `--8<--`, so a
|
|
# change here changes the rendered site even when no .md file moves.
|
|
- docs_src/**
|
|
- mkdocs.yml
|
|
- src/mcp/**
|
|
- src/mcp-types/**
|
|
- scripts/build-docs.sh
|
|
- scripts/docs/**
|
|
- pyproject.toml
|
|
- uv.lock
|
|
- .github/workflows/deploy-docs.yml
|
|
workflow_dispatch:
|
|
|
|
concurrency:
|
|
group: deploy-docs
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
deploy-docs:
|
|
runs-on: ubuntu-latest
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
|
|
with:
|
|
enable-cache: true
|
|
version: 0.9.5
|
|
|
|
- name: Build combined docs (main at / and /v2/, v1.x at /v1/)
|
|
run: bash scripts/build-docs.sh site
|
|
|
|
- name: Configure Pages
|
|
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
|
|
|
|
- name: Upload Pages artifact
|
|
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
|
|
with:
|
|
path: site
|
|
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
|