Document ChildProcess environment behavior

[IMax153]

Summary

• document that CommandOptions.extendEnv defaults to false
• warn that providing env without extendEnv: true replaces inherited variables, including PATH
• add an effect patch changeset

Validation

• pnpm lint
• pnpm docgen from packages/effect
• git diff --check

Closes #6709

Summary by CodeRabbit

• Documentation
  • Clarified that CommandOptions.extendEnv defaults to false.
  • Documented that providing env replaces the inherited child environment unless extendEnv: true is enabled.
  • Added guidance on PATH inheritance behavior.

[changeset-bot]

🦋 Changeset detected

Latest commit: bac4776

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 29 packages

Name	Type
effect	Patch
@effect/opentelemetry	Patch
@effect/platform-browser	Patch
@effect/platform-bun	Patch
@effect/platform-deno	Patch
@effect/platform-node-shared	Patch
@effect/platform-node	Patch
@effect/vitest	Patch
@effect/ai-anthropic	Patch
@effect/ai-openai-compat	Patch
@effect/ai-openai	Patch
@effect/ai-openrouter	Patch
@effect/atom-react	Patch
@effect/atom-solid	Patch
@effect/atom-vue	Patch
@effect/sql-clickhouse	Patch
@effect/sql-d1	Patch
@effect/sql-libsql	Patch
@effect/sql-mssql	Patch
@effect/sql-mysql2	Patch
@effect/sql-pg	Patch
@effect/sql-pglite	Patch
@effect/sql-sqlite-bun	Patch
@effect/sql-sqlite-do	Patch
@effect/sql-sqlite-node	Patch
@effect/sql-sqlite-react-native	Patch
@effect/sql-sqlite-wasm	Patch
@effect/docgen	Patch
@effect/openapi-generator	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fa9bc239-079b-41ac-9150-d76266c733c8

📥 Commits

Reviewing files that changed from the base of the PR and between 75f340e and bac4776.

📒 Files selected for processing (2)

• .changeset/document-child-process-env.md
• packages/effect/src/unstable/process/ChildProcess.ts

---

📝 Walkthrough

Walkthrough

Documents that CommandOptions.extendEnv defaults to false, and clarifies that providing env without enabling extension replaces the inherited child environment, potentially excluding PATH. A patch changeset records the documentation update.

Changes

Child process environment documentation

Layer / File(s)	Summary
Document extendEnv defaults and env replacement behavior packages/effect/src/unstable/process/ChildProcess.ts, .changeset/document-child-process-env.md	JSDoc and the changeset explain the false default, environment replacement behavior, and possible loss of PATH.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

• Effect-TS/effect#6652: Clarifies and implements related CommandOptions.extendEnv behavior.

Suggested reviewers: tim-smart

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	The docs now state extendEnv defaults to false and warn that env without it replaces the child environment, including PATH.
Out of Scope Changes check	✅ Passed	The PR only changes documentation and a changeset, which stays within the requested doc-only scope.

---

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

Bundle Size Analysis

File Name	Current Size	Previous Size	Difference
basic.ts	6.63 KB	6.63 KB	0.00 KB (0.00%)
batching.ts	9.42 KB	9.42 KB	0.00 KB (0.00%)
brand.ts	6.31 KB	6.31 KB	0.00 KB (0.00%)
cache.ts	10.12 KB	10.12 KB	0.00 KB (0.00%)
config.ts	19.90 KB	19.90 KB	0.00 KB (0.00%)
differ.ts	20.03 KB	20.03 KB	0.00 KB (0.00%)
http-client.ts	20.94 KB	20.94 KB	0.00 KB (0.00%)
logger.ts	10.28 KB	10.28 KB	0.00 KB (0.00%)
metric.ts	8.55 KB	8.55 KB	0.00 KB (0.00%)
optic.ts	7.46 KB	7.46 KB	0.00 KB (0.00%)
pubsub.ts	14.26 KB	14.26 KB	0.00 KB (0.00%)
queue.ts	11.09 KB	11.09 KB	0.00 KB (0.00%)
schedule.ts	10.27 KB	10.27 KB	0.00 KB (0.00%)
schema-class.ts	18.86 KB	18.86 KB	0.00 KB (0.00%)
schema-fromJsonSchemaDocument.ts	28.78 KB	28.78 KB	0.00 KB (0.00%)
schema-representation-roundtrip.ts	25.09 KB	25.09 KB	0.00 KB (0.00%)
schema-string-transformation.ts	12.95 KB	12.95 KB	0.00 KB (0.00%)
schema-string.ts	10.65 KB	10.65 KB	0.00 KB (0.00%)
schema-template-literal.ts	14.85 KB	14.85 KB	0.00 KB (0.00%)
schema-toArbitraryLazy.ts	21.66 KB	21.66 KB	0.00 KB (0.00%)
schema-toCodeDocument.ts	24.10 KB	24.10 KB	0.00 KB (0.00%)
schema-toCodecJson.ts	19.00 KB	19.00 KB	0.00 KB (0.00%)
schema-toEquivalence.ts	18.73 KB	18.73 KB	0.00 KB (0.00%)
schema-toFormatter.ts	18.59 KB	18.59 KB	0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts	22.23 KB	22.23 KB	0.00 KB (0.00%)
schema-toRepresentation.ts	19.27 KB	19.27 KB	0.00 KB (0.00%)
schema.ts	18.12 KB	18.12 KB	0.00 KB (0.00%)
stm.ts	12.05 KB	12.05 KB	0.00 KB (0.00%)
stream.ts	9.37 KB	9.37 KB	0.00 KB (0.00%)