improvement(setup): complete knowledge and update flows - #6521
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR SummaryMedium Risk Overview The setup wizard now prompts for knowledge embedding providers (OpenAI listed first) across compose, dev, and k8s flows—including quick setup—with a “Not now” opt-out so indexing can stay disabled. Capability setup supports no current provider ( Reviewed by Cursor Bugbot for commit 072e884. Bugbot is set up for automated code reviews on this repo. Configure here. |
Greptile SummaryThe PR completes optional knowledge-embedding configuration across Compose, development, and Kubernetes setup flows, while preserving existing configuration when users defer setup. It also adds a Docker Compose update lifecycle command and documents the new upgrade workflow.
Confidence Score: 5/5The PR appears safe to merge with no actionable defects identified in the changed setup or update flows. Optional embedding setup preserves deferred and existing configurations, provider transitions are validated before persistence, and the Compose update command applies the appropriate pull or rebuild operation without removing data volumes.
|
| Filename | Overview |
|---|---|
| scripts/setup/capability-setup.ts | Adds optional, non-destructive capability prompting and supports capabilities with no current configuration. |
| scripts/setup/steps.ts | Introduces the reusable optional knowledge-embedding setup step. |
| scripts/setup/modes/compose.ts | Integrates embedding configuration into both quick and custom Compose setup. |
| scripts/setup/modes/dev.ts | Integrates embedding configuration into local development setup and persists staged transitions. |
| scripts/setup/modes/k8s.ts | Preserves existing Helm embedding fields and applies optional provider changes during upgrades. |
| scripts/setup/lifecycle.ts | Adds Compose update behavior while retaining project identity and data volumes. |
| scripts/setup/lifecycle.test.ts | Covers lifecycle command recognition and published-versus-source update selection. |
| scripts/setup/steps.test.ts | Covers unconfigured knowledge embeddings and configuration from an empty state. |
| apps/docs/content/docs/en/platform/self-hosting/upgrades.mdx | Documents bun run sim update as the supported Docker Compose upgrade path. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
Setup[Run setup wizard] --> Mode{Install mode}
Mode --> Compose[Docker Compose]
Mode --> Dev[Local development]
Mode --> K8s[Kubernetes]
Compose --> Embeddings[Optional knowledge embedding setup]
Dev --> Embeddings
K8s --> Preserve[Load existing Helm embedding values]
Preserve --> Embeddings
Embeddings --> Choice{Provider choice}
Choice --> OpenAI[OpenAI]
Choice --> Azure[Azure OpenAI]
Choice --> OpenRouter[OpenRouter]
Choice --> Skip[Not now: preserve configuration]
OpenAI --> Persist[Persist environment transition]
Azure --> Persist
OpenRouter --> Persist
Skip --> Deploy[Continue setup unchanged]
Persist --> Deploy
Update[sim update] --> Install{Detected install}
Install --> Prod[Published Compose: pull images]
Install --> Local[Source Compose: build with pull]
Prod --> Apply[docker compose up -d]
Local --> Apply
Reviews (1): Last reviewed commit: "improvement(setup): complete knowledge a..." | Re-trigger Greptile
Summary
bun run sim updatefor safe Docker Compose image updatesType of Change
Testing
bun run test:setupbun run type-checkbun run lintorigin/stagingbun run check:auditsChecklist