Conversation
Add an opt-in completion listener that dispatches the website workflow with the successful upstream main Docs run identity using a scoped App token. Keep notification failures separate from source documentation CI. Preserve current Pages publishing by default and add an explicit switch for the later verified central deployment handoff.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review. 📝 WalkthroughWalkthroughThe change gates local Docs artifact publishing and deployment with ChangesDocs publishing handoff
Estimated code review effort: 3 (Moderate) | ~20 minutes Merge Risk: ⚪ Minimal · up to Documentation publishing remains unchanged by default; when enabled, successful main Docs runs can notify the central site workflow without leaving local Pages deployment enabled in central mode. The change is ready to merge. Sequence Diagram(s)sequenceDiagram
participant DocsWorkflow
participant NotifyWorkflow
participant GitHubApp
participant CentralDocsRepository
DocsWorkflow->>NotifyWorkflow: completed successful main run
NotifyWorkflow->>GitHubApp: create repository-scoped token
GitHubApp-->>NotifyWorkflow: actions write token
NotifyWorkflow->>CentralDocsRepository: dispatch docs-site.yml with source metadata
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. A rabbit reads each line, Comment |
Summary
After a successful upstream main Docs run, an opt-in completion listener requests the website's central documentation build using a website-scoped GitHub App token. Notification failures are reported separately from the completed Docs validation. Existing Pages publishing remains the default until an explicit handoff switch is set.
Changes
docs-site.ymlon main.DOCS_SITE_NOTIFY_ENABLED,DOCS_SITE_APP_ID, andDOCS_SITE_APP_PRIVATE_KEYbefore notifying; the App token only requests website Actions write permission.DOCS_SITE_PUBLISHER=centralto retire the original artifact upload and deployment after the central artifact and Pages routing handoff are verified.Verification
pre-commit run --files .github/workflows/docs.yml .github/workflows/notify-docs-site.yml: all applicable checks passed.actionlint -color .github/workflows/docs.yml .github/workflows/notify-docs-site.yml: passed.git diff --check: passed.