Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/comparisons.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ docs! We don't want to be biased, but it's easy that we tend to be:
[ejs]: https://ejs.co/

[^1]: The file itself can [include other YAML files][include-other-yaml-files].

[^2]:
Git repo is recommended to be able to use advanced features such as template tagging
and smart updates.
Expand All @@ -50,6 +51,7 @@ docs! We don't want to be biased, but it's easy that we tend to be:
and extract smart diffs between them.

[^5]: Context hooks are provided through the [`ContextHook` extension][context-hook].

[^6]: Updates are possible through [Cruft][cruft].

[context-hook]:
Expand Down
19 changes: 9 additions & 10 deletions docs/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -1191,8 +1191,8 @@ Migrations are like [tasks][tasks], but each item can have additional keys:

- **command**: The migration command to run
- **version** (optional): Indicates the version that the template update has to go
through to trigger this migration. It is evaluated using [PEP 440][]. If no version
is specified the migration will run on every update.
through to trigger this migration. It is evaluated using [PEP 440][]. If no version is
specified the migration will run on every update.
- **when** (optional): Specifies a condition that needs to hold for the task to run.
By default, a migration will run in the after upgrade stage.
- **working_directory** (optional): Specifies the directory in which the command will
Expand Down Expand Up @@ -1226,12 +1226,11 @@ processes will receive these variables:
- `_version_pep440_from`/`$VERSION_PEP440_FROM`,
`_version_pep440_to`/`$VERSION_PEP440_TO`,
`_version_pep440_current`/`$VERSION_PEP440_CURRENT`: Same as the above, but
normalized into a standard [PEP 440][] version. In Jinja templates these are
represented as
[packaging.version.Version](https://packaging.pypa.io/en/stable/version.html#packaging.version.Version)
objects and allow access to their attributes. As environment variables they are
represented as strings. If you use variables to perform migrations, you probably
will prefer to use these variables.
normalized into a standard [PEP 440][] version. In Jinja templates these are represented
as [packaging.version.Version](https://packaging.pypa.io/en/stable/version.html#packaging.version.Version)
objects and allow access to their attributes. As environment variables they are represented
as strings. If you use variables to perform migrations, you probably will prefer to use
these variables.

[git describe]: https://git-scm.com/docs/git-describe
[pep 440]: https://www.python.org/dev/peps/pep-0440/
Expand Down Expand Up @@ -1271,8 +1270,8 @@ can't be used in jinja templates.

Specifies the minimum required version of Copier to generate a project from this
template. The version must be follow the [PEP 440][] syntax. Upon generating or updating
a project, if the installed version of Copier is less than the required one, the
generation will be aborted and an error will be shown to the user.
a project, if the installed version of Copier is less than the required one, the generation
will be aborted and an error will be shown to the user.

!!! info

Expand Down
Loading
Loading