Skip to content

improvement(setup): complete knowledge and update flows - #6521

Merged
TheodoreSpeaks merged 1 commit into
stagingfrom
fix/kb-enable
Aug 11, 2026
Merged

improvement(setup): complete knowledge and update flows#6521
TheodoreSpeaks merged 1 commit into
stagingfrom
fix/kb-enable

Conversation

@TheodoreSpeaks

Copy link
Copy Markdown
Collaborator

Summary

  • allow knowledge embedding setup from an unconfigured state and include it in quick/custom setup with OpenAI first
  • add a non-destructive opt-out and preserve existing Helm embedding configuration
  • add bun run sim update for safe Docker Compose image updates

Type of Change

  • Bug fix
  • Improvement

Testing

  • bun run test:setup
  • bun run type-check
  • bun run lint
  • block registry check against origin/staging
  • bun run check:audits

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Aug 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 11, 2026 2:02am

Request Review

@cursor

cursor Bot commented Aug 11, 2026

Copy link
Copy Markdown

PR Summary

Medium Risk
Changes the self-host upgrade procedure and wizard env writes for embeddings; sim update only affects Compose but runs migrations on restart, so version pinning and backup practices still matter.

Overview
Adds bun run sim update as the documented Docker Compose upgrade path: it pulls images for docker-compose.prod.yml or rebuilds with --pull for docker-compose.local.yml, then runs compose up -d while keeping data volumes. Dev and Kubernetes installs get clear errors pointing to git/helm instead.

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 (resolveCurrentCapabilitySetupOptionId may be undefined), and Helm setup re-applies existing embedding env before optional reconfiguration.

Reviewed by Cursor Bugbot for commit 072e884. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps

greptile-apps Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The 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.

  • Adds non-destructive optional embedding-provider prompts with OpenAI first.
  • Preserves existing Helm embedding values during upgrades.
  • Adds bun run sim update with pull behavior for published images and rebuild behavior for source installs.
  • Extends setup and lifecycle tests for fresh embedding configuration and update-mode selection.

Confidence Score: 5/5

The 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.

Important Files Changed

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
Loading

Reviews (1): Last reviewed commit: "improvement(setup): complete knowledge a..." | Re-trigger Greptile

@TheodoreSpeaks
TheodoreSpeaks merged commit 5478a69 into staging Aug 11, 2026
30 checks passed
@waleedlatif1
waleedlatif1 deleted the fix/kb-enable branch August 11, 2026 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant