Commit ba4b9b4
authored
docs(worktree): fix stale rename example + document copyFiles properly (#1328)
Three related fixes around the `worktree.copyFiles` primitive:
1. Remove the `.env.example -> .env` rename example from
reference/configuration.md and getting-started/overview.md. The
`->` parser was removed in #739 (2026-03-19) because it caused
the stale-credentials production bug in #228 — but the docs kept
advertising it. A user writing `.env.example -> .env` today gets
`parseCopyFileEntry` returning `{source: '.env.example -> .env',
destination: '.env.example -> .env'}`, stat() fails with ENOENT,
and the copy silently no-ops at debug level.
2. Replace the single-line "Default behavior: .archon/ is always
copied" note with a proper "Worktree file copying" subsection
that explains:
- Why this exists (git worktree add = tracked files only; gitignored
workflow inputs need this hook)
- The `.archon/` default (no config needed for the common case)
- Common entries: .env, .vscode/, .claude/, plans/, reports/,
data fixtures
- Semantics: source=destination, ENOENT silently skipped, per-entry
error isolation, path-traversal rejected
- Interaction with `worktree.path` (both layouts get the same
treatment)
3. Update the overview example to drop the `.env.example + .env` pair
(which implied rename semantics) in favor of `.env + plans/`, and
call out that `.archon/` is auto-copied so users don't list it.
No code changes. `bun run format:check` and `bun run lint` green.1 parent 08de8ee commit ba4b9b4
2 files changed
Lines changed: 35 additions & 6 deletions
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
383 | 383 | | |
384 | 384 | | |
385 | 385 | | |
386 | | - | |
387 | | - | |
388 | | - | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
389 | 389 | | |
390 | 390 | | |
391 | 391 | | |
| |||
Lines changed: 32 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
125 | | - | |
126 | | - | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
127 | 128 | | |
| 129 | + | |
128 | 130 | | |
129 | 131 | | |
130 | 132 | | |
| |||
171 | 173 | | |
172 | 174 | | |
173 | 175 | | |
174 | | - | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
175 | 204 | | |
176 | 205 | | |
177 | 206 | | |
| |||
0 commit comments