docs: warn that a relative local template path breaks copier update - #374
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A template developer who renders from a local checkout with a relative path (as opposed to the walkthrough's
gh:URL) gets a project whose firstcopier updatefails with a confusing "Local template must be a directory." error — copier records the source argument verbatim as_src_pathand resolves it from the project directory at update time.This adds a short aside to step 01 §1a: render from a
gh:/https:URL or an absolute path, why (with the upstream references copier-org/copier#335 and pending fix copier-org/copier#2717), and the one-line repair for an already-rendered project (hand-edit_src_path). Docs only, no code change — the real correction is queued upstream.Closes #373