ci: notify adp-docs when rpk ai partials change on main - #1852
Conversation
adp-docs publishes rpk ai through single-source stubs of this repo's generated partials. When a merged change adds or removes partials, its static stub pages and nav drift (invisible commands or broken includes). Dispatch sync-rpk-ai-stubs so adp-docs reconciles its stubs automatically.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughAdds a GitHub Actions workflow that runs when rpk ai partial files change on Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
@micheleRP when you're reviewing the train, this is the sender half of the adp-docs stub sync (receiver: redpanda-data/adp-docs#165) — it closes the manual stub/nav follow-up from your #161 review. Fires on merges to main that touch the rpk-ai partials. |
|
No findings. Push-on-main with a path filter is the right trigger, the permissions are minimal, and this is the workflow in the set that gets the token pattern right: fetching the actions bot token from Secrets Manager rather than using One ordering note: the receiver in redpanda-data/adp-docs#165 currently produces an unbuildable PR while the two stale |
…ow-ups at the automated sync PRs created with secrets.GITHUB_TOKEN do not trigger the repo's own Actions workflows, so the automated rpk PRs — the largest in the repo — were the only ones with no run-tests validation (observed on #1845: Netlify ran, setup and run-tests never did). Fetch the actions bot token and create PRs with it, matching the senders' pattern. Also reword the rpk-ai structural-change comment to point at the automated adp-docs stub sync instead of instructing a manual stub/nav edit (misleading once #1852 and adp-docs#165 land), and add a job timeout.
2 participants
Summary
adp-docs publishes the
rpk aireference through single-source stubs of this repo's generated partials (redpanda-data/adp-docs#161). When a merged change adds or removesrpk-aipartials, adp-docs' static stub pages and nav drift: new commands are invisible on the ADP site, and removed commands leave stubs with unresolved includes.This dispatches
sync-rpk-ai-stubsto adp-docs whenevermodules/reference/partials/rpk-ai/**changes on main — the moment the partials become real for adp-docs' builds. The receiving workflow redpanda-data/adp-docs#165 runs the doc-tools stub reconciler and opens an adp-docs PR with the stub and nav changes, plus proposed page aliases for likely renames.Together with docs#1834 this closes the loop Michele described: ADP release → docs partials PR → (merge) → adp-docs stub PR → (merge). The only human steps are the two PR reviews.
Depends on docs-extensions-and-macros#225 (
rpk-plugin-stubscommand, doc-tools 5.3.0). Recommend merging docs#1849 first so the first reconcile run doesn't resurrect stubs for the two stale partials it removes (verified in a dry run against current main).Related PRs (rpk docs automation train)
--pluginmode, change detection, deprecations, What's-new merge, flag extraction, stub reconciler (publishes doc-tools 5.3.0)Merge order: #225 → dependency bumps on docs main and beta → #1834 + #1844 (+ #1849) → #1852 + adp-docs#165 → remaining senders. Jira: DOC-2355, DOC-1090.