Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lkubb committed Aug 12, 2024
1 parent 30f2a77 commit ce7c91a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -1312,8 +1312,9 @@ configuring `secret: true` in the [advanced prompt format][advanced-prompt-forma
- CLI flags: `-s`, `--skip`
- Default value: `[]`

[Patterns][patterns-syntax] for files/folders that must be skipped if they already
exist.
[Patterns][patterns-syntax] for files/folders that must be skipped only if they already
exist, but always be present. If they do not exist in a project
during an `update` operation, they will be recreated.

!!! example

Expand Down
10 changes: 10 additions & 0 deletions docs/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,16 @@ As you can see here, `copier` does several things:
- Finally, it re-applies the previously obtained diff and then runs the
post-migrations.

### Handling of deleted paths

Template-based files/directories that were deleted in the generated project
are automatically excluded from updates. If you want to recover such a file
later on, you can run `copier recopy` and recommit it to your repository.
Subsequent updates for the path will then be respected again.

An exception to this behavior applies to paths that are matched by `skip_if_exists`.
Their presence is always ensured, even during an `update` operation.

### Recover from a broken update

Usually Copier will replay the last project generation without problems. However,
Expand Down

0 comments on commit ce7c91a

Please sign in to comment.