Document _copier_conf.operation

copier-org · Aug 17, 2024 · 54fc0b7 · 54fc0b7
1 parent f010d84
commit 54fc0b7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/configuring.md b/docs/configuring.md
@@ -857,6 +857,17 @@ to know available options.
 [Patterns][patterns-syntax] for files/folders that must not be copied.
 
 The CLI option can be passed several times to add several patterns.
+Each pattern can be templated using Jinja.
+
+!!! example
+
+    Templating `exclude` patterns using `_copier_conf.operation` allows to have files
+    that are rendered once during `copy`, but are never updated:
+
+    ```yaml
+    _exclude:
+        - '{%- if _copier_conf.operation == "update" -%}src/*_example.py{%- endif %}'
+    ```
 
 !!! info
 
@@ -1315,6 +1326,7 @@ configuring `secret: true` in the [advanced prompt format][advanced-prompt-forma
 [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.
+Each pattern can be templated using Jinja.
 
 !!! example
 

diff --git a/docs/creating.md b/docs/creating.md
@@ -99,3 +99,4 @@ Copier includes:
     -   It contains the current commit hash from the template in
         `{{ _copier_conf.vcs_ref_hash }}`.
     -   Contains Operating System-specific directory separator under `sep` key.
+    -   It also contains the current `operation` (`copy` | `recopy` | `update`).