Skip to content

docs: require warm completion before starting the app #468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
janicduplessis merged 1 commit into from
Sep 7, 2026
Merged

docs: require warm completion before starting the app #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/stim-cli/src/__tests__/guide.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,11 +219,14 @@ test('the errors topic documents every code the build commands and the iOS signi
}
});

test('current guides expose warm and remove while leaving worktree creation to Git', () => {
test('current guides require completed warming and leave worktree creation to Git', () => {
const body = allBodies().join('\n');
expect(body).toContain('git worktree add');
expect(body).toContain('stim worktree warm');
expect(body).toContain('stim worktree remove');
for (const guide of [renderTopic('agent'), renderSection('lifecycle', 'options')]) {
expect(guide).toContain('Wait for warm to exit successfully (exit code 0)');
}
expect(body).not.toMatch(/worktree create|--carry-ignored|STIM_WORKTREE_BRANCH_EXISTS/);
expect(body).not.toMatch(/worktreeDir|worktree\.baseRef|worktree\.include|\.worktreeinclude/);
expect(sectionLookup('errors')['STIM_WORKTREE_BRANCH_EXISTS']).toBeUndefined();
Expand Down
6 changes: 6 additions & 0 deletions packages/stim-cli/src/guide/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ configuration files. It preserves the branch, tracked files, and every existing
destination entry; existing ignored directories are skipped whole, not filled in.
Read guide lifecycle options for exclusions and incomplete-copy remedies.

Wait for warm to exit successfully (exit code 0) before running stim start,
stim ios, stim android, or a dependency install in that worktree. If the shell
tool returns a running session or job ID, poll or wait for that job to finish;
the ID is not completion. Do not install dependencies while warm is copying.
If warm fails or reports incomplete, resolve the reported failure first.

Before native worktree work, run doctor for the platform in scope. It checks
the main checkout from a linked worktree. Fix relevant findings and inspect the
upstream gap. It also prints the running CLI version and the stim installation
Expand Down
5 changes: 5 additions & 0 deletions packages/stim-cli/src/guide/lifecycle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,11 @@ OPT-IN CONCURRENCY LIMITS (UNLIMITED BY DEFAULT)
worktrees of the same Git repository; the main checkout
must be available. Running it in the main checkout refuses.

Wait for warm to exit successfully (exit code 0) before running start,
ios, android, or a dependency install in that worktree. If a shell tool
yields a running session or job ID, poll or wait for completion; empty
stdout or a returned job ID does not mean the copy has finished.

Warm copies installed dependencies, Pods, native output, and other ignored
paths eligible under the main checkout's Git ignore rules, including .env
and local configuration. The source's nonempty
Expand Down
Loading