chore: update deployment plan rfc for argo CR diff task - #1121
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
Disabled knowledge base sources:
📝 WalkthroughWalkthroughThis PR replaces RFC 0013 documentation, swapping the old "generalized deployment plans" RFC for a new "multi-kind plan results" RFC. The navigation entry is updated to point to the new RFC. The new RFC specifies extending the plan-result model to emit multiple labeled diffs per agent invocation via a ChangesRFC 0013 Replacement: Multi-Kind Plan Results
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
✨ 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 |
There was a problem hiding this comment.
Pull request overview
This PR updates the RFC documentation around deployment plan outputs by replacing the prior RFC 0013 (“Generalized Deployment Plans”) with a new RFC 0013 focused on supporting multiple diff outputs (“kinds”) per job agent invocation (e.g., surfacing an ArgoCD Application CR diff alongside the manifest diff). It also updates the docs navigation to point at the new RFC.
Changes:
- Add new RFC 0013 describing “multi-kind” plan results via a new
kindcolumn and updatedPlannable.Planreturn shape. - Remove the previous RFC 0013 (“Generalized Deployment Plans”) document.
- Update Mintlify docs navigation to reference the new RFC filename/slug.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/rfc/0013-multi-kind-plan-results.mdx | New RFC describing schema/controller/validation/UI implications for multiple plan result kinds per agent invocation. |
| docs/rfc/0013-generalized-deployment-plans.mdx | Removed prior RFC 0013 content (generalized plan triggers/snapshots). |
| docs/docs.json | Docs navigation updated to point RFC 0013 at the new “multi-kind plan results” page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```go | ||
| type PlanResult struct { | ||
| Kind string | ||
| Current string | ||
| Proposed string | ||
| HasChanges bool | ||
| ContentHash string | ||
| Status, Message, State, CompletedAt // unchanged | ||
| } |
| `argocd_plan.go:111`) — used to create a temp Application, then discarded | ||
| after the downstream manifest diff is extracted. |
| ```json | ||
| { | ||
| "manifest": { "current": <parsed>, "proposed": <parsed>, "has_changes": true }, | ||
| "cr": { "current": <parsed>, "proposed": <parsed>, "has_changes": true }, | ||
| "agent_type": "argo-cd", | ||
| "deployment": { ... }, "environment": { ... }, "resource": { ... }, | ||
| "proposed_version": { ... }, "current_version": { ... } | ||
| } | ||
| ``` | ||
|
|
||
| Rules self-select via `input.manifest.proposed` / `input.cr.proposed`. No | ||
| DB-layer routing, no per-rule `applies_to_kind` declaration. Reserved | ||
| top-level keys — `agent_type`, `deployment`, `environment`, `resource`, | ||
| `proposed_version`, `current_version` — are documented; agents shouldn't use | ||
| these as section names. |
Summary by CodeRabbit