ci: deploy docs to GitHub Pages#62
Merged
Merged
Conversation
Add a Pages deploy workflow (build VitePress, upload, deploy) triggered on docs changes to main and via manual dispatch. Pages source is set to GitHub Actions; the site publishes at https://gemstack-land.github.io/gemstack/. config.ts gains a configurable base (process.env.DOCS_BASE || '/'). The workflow sets DOCS_BASE=/gemstack/ for the project-pages URL; local dev and a future custom domain keep the root base. Drop that env from the workflow once gemstack.land is attached.
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
1 participant
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.
Makes the docs site reachable. Pages is already enabled on the repo with GitHub Actions as the source.
What
.github/workflows/deploy-docs.yml- builds the VitePress site and deploys it to GitHub Pages, on pushes tomainthat touchdocs/**(or the workflow itself) and via manualworkflow_dispatch. Standardconfigure-pages->upload-pages-artifact->deploy-pagesflow withpages: write/id-token: writepermissions and apagesconcurrency group.config.ts-baseis nowprocess.env.DOCS_BASE || '/'. The workflow setsDOCS_BASE=/gemstack/so assets resolve under the project-pages path; local dev and a future custom domain keep the root base.Result
On merge, the site publishes at https://gemstack-land.github.io/gemstack/.
Follow-ups (not blocking)
gemstack.landis ready, attach it as the Pages custom domain and removeDOCS_BASEfrom the workflow (base returns to/).bloblinks in the rudder docs (ai.md/mcp.md) and this repo's README to the live site.Verified locally:
DOCS_BASE=/gemstack/ pnpm --filter @gemstack/docs docs:buildis green and bakes/gemstack/into the asset URLs. No changeset.