Skip to content

Commit c265161

Browse files
committed
docs: warn about legacy worktree default
1 parent e2e95b4 commit c265161

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,13 @@ The `${WTP_REPO_BASENAME}` placeholder expands to the repository's directory
218218
name when resolving paths, ensuring zero-config isolation between different
219219
repositories. You can combine it with additional path segments as needed.
220220

221+
> **Breaking change (vNEXT):** If you relied on the previous implicit default
222+
> of `../worktrees` without a `.wtp.yml`, existing worktrees will now appear
223+
> unmanaged because the new default expects
224+
> `../worktrees/${WTP_REPO_BASENAME}`. Add a `.wtp.yml` with
225+
> `base_dir: "../worktrees"` (or reorganize your worktrees) before upgrading
226+
> to keep the legacy layout working.
227+
221228
### Copy Hooks: Main Worktree Reference
222229

223230
Copy hooks are designed to help you bootstrap new worktrees using files from

0 commit comments

Comments
 (0)