Skip to content

Commit d884e8d

Browse files
committed
docs: warn that a relative local template path breaks copier update
Copier records the source argument verbatim as _src_path and resolves it from the project directory at update time, so a render from a relative local path is dead on the first copier update (copier-org/copier#335; fix pending upstream in copier-org/copier#2717). Add a step-01 aside: render from a URL or an absolute path, and hand-edit _src_path to repair an existing render. Issue: #373 Signed-off-by: Eduard R. <eduard@ralphovi.net>
1 parent 77401c5 commit d884e8d

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/01-render-and-integrate.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ copier copy gh:eduralph/pdca-harness ../gramps-testbed-v2
2020
cd ../gramps-testbed-v2
2121
```
2222

23+
> **Rendering from a local checkout instead?** Give copier a `gh:`/`https:`
24+
> URL (as above) or an **absolute** path. Copier records the source argument
25+
> verbatim as `_src_path` in `.copier-answers.yml`, and `copier update`
26+
> resolves it from the *project* directory — a path relative to your render
27+
> cwd never resolves there, so the first `copier update` fails
28+
> ([copier#335](https://github.com/copier-org/copier/issues/335); fix pending
29+
> in [copier#2717](https://github.com/copier-org/copier/pull/2717)). Already
30+
> rendered that way? Hand-edit `_src_path` to the template URL or an absolute
31+
> path — that's the whole repair.
32+
2333
The prompts (from [`copier.yml`](../copier.yml)) and what gramps answered:
2434

2535
| Prompt | What it sets | gramps-testbed-v2 |

0 commit comments

Comments
 (0)