Repository navigation
docs: document the upgrade path for existing installs - #24
Merged
Merged
Conversation
The README only covered fresh installs. Existing users had no documented way to pick up the observation migrations, and the engine task name (rcrew_ai_rails, from the AI acronym inflection) is not guessable.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Gap
The README only documented the fresh install path (
rails generate rcrewai:rails:install). Running that against an app that already has the RcrewAI tables creates every table again and fails on duplicates — so existing users had no documented way to pick up the observation engine's two new migrations.The mechanism already worked; it was simply undiscoverable. The engine exposes
db/migrateby convention, so the standard Rails task copies what's missing:Note the task name is
rcrew_ai_rails, notrcrewai_rails— an artifact of theAIacronym inflection, and not something anyone would guess. Verified againstEngine.railtie_name.Changes
Docs only — no code, no behavior change.
observation_enabled = false), and a caveat for hand-rolled schemas (likely, since the install generator never copied a migration before 0.7.0).### Upgradingentry under 0.7.0 carrying the same guidance.Verified
Engine.paths["db/migrate"]resolves, soinstall:migrationsfinds all 11 migrations and Rails copies only those the host lacks — an app on 0.6.x gets exactly010and011.Engine.railtie_name→rcrew_ai_rails, matching the documented command.