docs(migration): Create migrate-to-minimal-session.md - #1003
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughUpdates the v0.5.0+ migration guide with command compatibility, Linux ChangesSessions migration documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guide/migrate-to-minimal-session.md`:
- Around line 48-52: Rewrite the migration text around the `[session]` section
so it clearly states that `[session]` defines interactive environments for
shell, bash, and interactive agent tasks. Correct “Task defined with” to plural
wording and explicitly instruct that tasks with `interactive = true` should be
migrated to session definitions, preserving the existing configuration
reference.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9f67abbd-a84a-48f1-a57a-09f0f6303d5f
📒 Files selected for processing (1)
docs/guide/migrate-to-minimal-session.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guide/migrate-to-minimal-session.md`:
- Around line 11-18: Update the migration guidance around the `tasks`
compatibility warning and `uninstall.sh` command so users who rely on
non-interactive tasks keep `minimal` installed alongside `min`. Make the
uninstall instruction conditional on users no longer needing `minimal`, and
clarify the side-by-side installation requirement.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2e820f0b-fab3-48b4-8162-3777bc592e68
📒 Files selected for processing (1)
docs/guide/migrate-to-minimal-session.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
cea1f52 to
12c4cdd
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guide/migrate-to-minimal-session.md`:
- Around line 22-27: Correct the Linux migration examples in the documented
command mapping so the `minimal add` example uses `mip add` rather than `mip
update`, while leaving the `run` and `update` mappings unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d2362485-ac74-40f7-a24b-17aba8b53a06
📒 Files selected for processing (1)
docs/guide/migrate-to-minimal-session.md
Summary
Added a migration guide for Minimal One
Testing
Checklist
BREAKING CHANGE:footer present if this is a breaking changeNote
Add migration guide for moving to the Minimal Sessions architecture in v0.5.0
Adds migrate-to-minimal-session.md covering the transition from legacy
minimalto the newmincommand introduced in v0.5.0.minimalis preserved but tasks are unsupported in v0.5.0, with uninstall instructions and a pointer tomininstallation docsmip(Minimal-In-Process), including a command mapping fromminimaltomipminimal.tomlschema changes:harnessrenamed tostack,profilesdeprecated, and a new[session]section addedmin activate,min attach,--attach) and instructions for migrating profile env vars and packages tosession.varsandsession.packagesChanges since #1003 opened
[session]configuration section to replace interactive task definitions, with migration guidance fromshell,bash, andagenttask types to session-based workflows usingmin activateandmin attachcommands [a9a090f][harness]configuration section to[stack]inminimal.toml, with guidance that[upstream]and[outputs]sections remain unchanged,[defaults]profiles are deprecated, and tasks split between interactive (moved to sessions) and non-interactive (remain as tasks) [a9a090f]minimalCLI command withmipcommand on Linux, providing command mapping table showing old versus new command syntax and noting that in-VMmin addcommand remains unchanged [a9a090f]profile.env_varstosession.varsand fromprofile.packagestosession.packagesas part of profiles deprecation [a9a090f]minalongside legacyminimal[a9a090f]Macroscope summarized 2969ef5.
Summary by CodeRabbit
Summary by CodeRabbit
tasksmust be migrated and that non-interactive, job-like workflows no longer supporttasks.minimal→min, including uninstall steps for legacyminimaland updatedminimal.tomlmigration: renameharness→stack, add[session], and deprecateprofileswith a mapping to sessionvars/packages.mipas an in-place command mapping forminimal.