ci(api-docs): isolate per-package builds and stabilize root URL - #241
Merged
Conversation
Adds tags:['**'] so the API Reference Deployment workflow fires on tag pushes, not just main. Inert until a tag is pushed; per-package routing and root-redirect handling follow in subsequent PRs.
Routes each tag to a single package built at /<pkg>/<version>/, builds dev from main, and rebuilds the root README only on tag pushes so the root URL stops flapping. Drops the destructive content wipe and macOS sed dance.
twishabansal
marked this pull request as draft
June 2, 2026 06:50
twishabansal
force-pushed
the
api-docs-per-package-isolation
branch
2 times, most recently
from
June 2, 2026 08:01
652e6e7 to
1ac28c9
Compare
twishabansal
marked this pull request as ready for review
June 2, 2026 08:19
This was referenced Jun 2, 2026
anubhav756
approved these changes
Jun 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes two defects in the API reference docs pipeline (go.mcp-toolbox.dev) and cleans up the generation scripts:
/<pkg>/<version>/pushes to main build all three as //dev/./ping-ponged between dev and the latest tagged version. The root (repo README) is now rebuilt only on tag pushes, so it tracks the latest release and stays stable between dev builds.URL model after this PR
How it was tested
Tested locally against the exact CI Hugo version (
0.152.2extended).1. Install the CI Hugo and lint the workflow
2. Replay the two workflow scenarios into one shared
public/tree (mimics deploying a tag on top of the existing dev site, which is how isolation gets verified)3. Assert isolation, stable root, and content
All assertions returned the expected values (isolation preserved, root is the README with 0 meta-refresh redirects, tag page shows
Viewing v1.0.0+ gomarkdoc API symbols,docs-site/contentnot wiped).4. Visual spot-check