Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 164 additions & 0 deletions .github/workflows/api-docs-backfill.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


name: "API Reference Backfill"
on:
workflow_dispatch:
inputs:
package:
description: "Package to backfill"
type: choice
options: [core, adk, langchain, llamaindex]
required: true
version:
description: "Version tag to build, e.g. v1.0.0"
type: string
required: true

# Scope per version: each run produces an independent branch/PR, so runs for
# different versions can proceed in parallel. A shared group with
# cancel-in-progress: false would make GitHub cancel a pending run whenever a
# newer one queues, silently dropping versions when several are dispatched.
concurrency:
group: api-docs-backfill-${{ github.event.inputs.package }}-${{ github.event.inputs.version }}
cancel-in-progress: false

jobs:
backfill:
# Never run on forks; docs deploy only from the upstream repository.
if: github.repository == 'googleapis/mcp-toolbox-sdk-python'
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
# Build from main so the archived page carries the current version picker;
# only the package's source comes from the tag (overlaid below) so
# pydoc-markdown documents that version's API.
- name: Checkout main (current layout + scripts)
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
with:
ref: main
submodules: recursive

# Map the URL slug to its package directory (the slug is not the directory
# name).
- name: Resolve package directory
id: resolve
env:
PKG: ${{ inputs.package }}
run: |
case "$PKG" in
core) echo "dir=packages/toolbox-core" >> "$GITHUB_OUTPUT" ;;
adk) echo "dir=packages/toolbox-adk" >> "$GITHUB_OUTPUT" ;;
langchain) echo "dir=packages/toolbox-langchain" >> "$GITHUB_OUTPUT" ;;
llamaindex) echo "dir=packages/toolbox-llamaindex" >> "$GITHUB_OUTPUT" ;;
*) echo "Unknown package: $PKG" >&2; exit 1 ;;
esac

- name: Checkout tagged package source
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
with:
ref: refs/tags/toolbox-${{ inputs.package }}-${{ inputs.version }}
path: tagged_src
sparse-checkout: ${{ steps.resolve.outputs.dir }}

# Overlay only the tagged package's src/, keeping main's pyproject.toml and
# the docs tooling intact. pydoc-markdown parses src statically, so the
# archived page reflects the tagged version's API. (Go overlays the whole
# package dir; here src-only keeps the rest of main's layout in sync.)
- name: Overlay tagged source onto main
env:
DIR: ${{ steps.resolve.outputs.dir }}
run: |
rm -rf "$DIR/src"
mv "tagged_src/$DIR/src" "$DIR/src"

- name: Set up Python
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
with:
python-version: '3.13'

- name: Install doc generator
run: |
# pydoc-markdown parses the SDK source statically (no install/import of
# the packages), so no package build step is needed -- unlike the JS
# pipeline, which compiles types before TypeDoc runs.
pip install -r docs-site/requirements.txt

- name: Setup Hugo
uses: peaceiris/actions-hugo@2752ce1d29631191ea3f27c23495fa06139a5b78 # v3
with:
hugo-version: '0.152.2'
extended: true

- name: Install PostCSS Dependencies
run: |
# npm ci installs the exact versions from docs-site/package-lock.json
# into docs-site/node_modules (where Hugo's PostCSS looks), so the
# build is reproducible -- a broken upstream patch can't be pulled in.
# docs-site/package.json pins postcss/postcss-cli/autoprefixer; the
# lockfile freezes their transitive deps.
cd docs-site
npm ci

- name: Build docs
env:
PKG: ${{ inputs.package }}
VER: ${{ inputs.version }}
# Deploys only run upstream (see job-level guard), so always use the
# production domain.
BASE_URL: https://py.mcp-toolbox.dev/
run: |
chmod +x scripts/generate-api-docs.sh
./scripts/generate-api-docs.sh "$PKG" "$VER" "$BASE_URL"

# Open a PR into gh-pages instead of deploying directly, so a human reviews
# before the page goes live. Overlaying the build onto a clone of the live
# gh-pages tree mirrors keep_files: true — existing files (other versions,
# CNAME, .nojekyll) are preserved and the PR diff is just this version.
- name: Open PR against gh-pages
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PKG: ${{ inputs.package }}
VER: ${{ inputs.version }}
run: |
set -euo pipefail
BRANCH="backfill/${PKG}-${VER}"
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"

WORK="$(mktemp -d)"
git clone --depth 1 --branch gh-pages --single-branch \
"https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" "$WORK"
cp -R "${GITHUB_WORKSPACE}/docs-site/public/." "$WORK/"

cd "$WORK"
git checkout -B "$BRANCH"
git add -A
if git diff --cached --quiet; then
echo "No documentation changes for ${PKG} ${VER}; skipping PR."
exit 0
fi
git commit -m "docs(api): backfill ${PKG} ${VER}"
git push -f origin "$BRANCH"

if gh pr view "$BRANCH" --json number >/dev/null 2>&1; then
echo "PR already open for ${BRANCH}; branch updated."
else
gh pr create --base gh-pages --head "$BRANCH" \
--title "docs(api): backfill ${PKG} ${VER}" \
--body "Automated API reference backfill for \`${PKG}/${VER}\`, built from main tooling with the tagged source overlaid. Merging publishes to gh-pages (additive)."
fi