feat: gate root docs deploys on releases, serve main under /preview/ - #234
Merged
Conversation
The root site now deploys only from a release (the release workflow dispatches the docs workflow at the tag, since GITHUB_TOKEN-created releases cannot fire the release trigger) or a manual dispatch. Docs pushes to main deploy to /preview/ instead, and both preview flavors emit a robots noindex meta so they never compete with the root site in search results.
Contributor
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Owner
Author
|
@coderabbitai full-review |
|
✅ Action performedFull review finished. |
📝 WalkthroughWalkthroughDocumentation deployment now responds to published releases and manual dispatches for production, with release workflows dispatching the documentation workflow at the release tag. Main branch builds deploy to a preserved preview directory, while pull-request and main previews receive 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/docs.yml:
- Around line 105-108: Disable the default dependency/build cache in the
actions/setup-go step identified by go-version-file: docs/go.mod by setting its
cache option to false, while leaving Go version setup unchanged. Ensure the
privileged documentation deployment job cannot restore or share setup-go cache
entries with the unprivileged PR-preview job.
In @.github/workflows/release.yml:
- Around line 107-114: Update the “Deploy docs for the release” step to pass
steps.latest.outputs.output through an environment variable, then reference that
variable in the gh workflow run command instead of interpolating the GitHub
expression directly in run. Preserve the existing docs.yml dispatch and
release-tag ref behavior.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2c19e121-5551-43e3-a5cc-0f6ffae2b8c9
📒 Files selected for processing (3)
.github/workflows/docs.yml.github/workflows/release.ymldocs/layouts/_partials/custom/head-end.html
The release tag predates the pin-update PR, so the root deploy at the tag still shows the previous release's wasm url/sha in its examples. Deploy again from main when the release/update-readme-* branch merges; main is then exactly the tag plus the pin commit.
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.
The docs root now only deploys on a release (or manual dispatch), while the current state of main lives at /preview/ and PR previews stay as they are - both noindexed.