From ce7c91a9a63885ae82dc06e3733b088f2e2c3834 Mon Sep 17 00:00:00 2001 From: jeanluc Date: Mon, 12 Aug 2024 17:43:56 +0200 Subject: [PATCH] Update docs --- docs/configuring.md | 5 +++-- docs/updating.md | 10 ++++++++++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/configuring.md b/docs/configuring.md index 95577bcbf..debc3448d 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -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 diff --git a/docs/updating.md b/docs/updating.md index ec9dec416..20a434a54 100644 --- a/docs/updating.md +++ b/docs/updating.md @@ -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,