Trigger Website rebuilds for Docs changes - #11
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (492)
📒 Files selected for processing (17)
📝 WalkthroughWalkthroughChangesComposed Docs deployment
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant DocsJob
participant NotifyWebsite
participant GitHubApp
participant Monorepo
DocsJob->>NotifyWebsite: complete successfully
NotifyWebsite->>GitHubApp: mint scoped contents-write token
GitHubApp-->>NotifyWebsite: return token
NotifyWebsite->>Monorepo: dispatch docs-updated with repository and commit SHA
Possibly related PRs
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
The setup.md prompt is the ranked best path for any agent that can fetch a URL and act on it — it publishes with a single HTTP request, no MCP or CLI required, and tells tool-less users what unlocks publishing. Plugin and one-click agents point to their per-agent setup pages; the CLI, setup command, skill, and MCP sections stay as the durable lanes.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 972fb0947d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| app-id: ${{ secrets.RELEASE_APP_ID }} | ||
| private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }} | ||
| owner: spacefast | ||
| repositories: monorepo |
There was a problem hiding this comment.
Move private repository identity out of the public workflow
Because this workflow is stored in the public docs repository, naming the private target here—and again in the dispatch endpoint—permanently exposes private repository metadata. Pass the target through a secret or another indirection instead of committing its identity.
AGENTS.md reference: AGENTS.md:L19-L21
Useful? React with 👍 / 👎.
What changed
docs-updatedevent with the exact Docs commit aftermainCI passeshttps://spacefast.com/docsdeploymentWhy
Docs are now built into the Website's static artifact instead of being served from a second Space. A Docs merge requests a Website rebuild; the Website workflow pins the exact Docs SHA and publishes the combined version atomically.
Depends on spacefast/monorepo#1629. Merge that PR first so the dispatch receiver and combined publisher exist before this workflow starts sending events.
Operational prerequisite
Configure
RELEASE_APP_IDandRELEASE_APP_PRIVATE_KEYin this repository for a GitHub App installed onspacefast/monorepowith repository dispatch permission.Validation
bun run check— 1,240 pages and zero type errorsbun run verify:routes— all 60 IA routes and 1,242 HTML pages verifiedbun run verify:generated— 508 generated artifacts verifiedThe optional broad audit still reports its existing missing-asset and broken-link backlog; the strict build, route, and generated-artifact gates pass.
Need help on this PR? Tag
@codesmithwith what you need. Autofix is disabled.Summary by CodeRabbit
Documentation
https://spacefast.com/docs.https://spacefast.com/setup.mdprompt, with fallback instructions and links to agent integrations.Deployment