Skip to content

ci(api-docs): prune superseded search indexes on deploy #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
twishabansal wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ci(api-docs): prune superseded search indexes on deploy #265

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 40 additions & 6 deletions .github/workflows/api-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,45 @@ jobs:
chmod +x scripts/generate-root.sh
./scripts/generate-root.sh "$BASE_URL"

# Overlay the build onto a clone of the live gh-pages tree in a single
# commit. This mirrors the old keep_files: true deploy — existing version
# dirs, CNAME, and .nojekyll are preserved — but additionally prunes
# superseded offline-search-index files. Each rebuilt directory gets a new
# content-hashed index, and under a purely additive deploy the previous one
# would linger forever (the dev dirs and root rebuild repeatedly). Mirrors
# the manual-overlay approach already used by api-docs-backfill.yml.
- name: Deploy to gh-pages
if: steps.resolve.outputs.packages != ''
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs-site/public
keep_files: true
cname: ${{ github.repository == 'googleapis/mcp-toolbox-sdk-go' && 'go.mcp-toolbox.dev' || '' }}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
set -euo pipefail
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"

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

# For every directory this build refreshes, drop the old search index so
# only the new content-hashed one survives the overlay below.
while IFS= read -r idx; do
dir="$(dirname "${idx#"$PUB"/}")"
rm -f "$WORK/$dir"/offline-search-index.*.json
done < <(find "$PUB" -name 'offline-search-index.*.json')

# Additive overlay (matches keep_files: true).
cp -R "$PUB/." "$WORK/"
# Preserve settings the peaceiris action used to manage.
echo "go.mcp-toolbox.dev" > "$WORK/CNAME"
touch "$WORK/.nojekyll"

cd "$WORK"
git add -A
if git diff --cached --quiet; then
echo "No documentation changes; nothing to deploy."
exit 0
fi
git commit -m "docs(api): deploy ${{ steps.resolve.outputs.packages }} @ ${{ steps.resolve.outputs.version }}"
git push origin gh-pages
Loading