Releases: copier-org/copier
Releases · copier-org/copier
v8.2.0 (2023-08-28)
Feat
- release on FlakeHub.com too
- add support for pre-update and post-update messages (#1288)
- add support for pre-copy and post-copy messages
Fix
- do not immediately fail if git is not available
- provide more clarification in unsafe error message (#1280)
- clean up tmp dir
- don't lie about updated files
- require default value for secret question
- fix answer validation against conditional choices with duplicate values
Refactor
- drop support for Python 3.7 (#1252)
v8.1.0 (2023-07-10)
Feat
- add support for computed values via skipped questions (#1220)
- add
--trust
as a less scary alternative to--UNSAFE
(#1179) - add OS identifier to render context
Fix
- pydantic: add upper dependency bound to fix unlocked installations
Refactor
- request answers imperatively instead of implicitly via impure property
v8.0.0 (2023-06-04)
BREAKING CHANGE
- Updates will overwrite existing files always. If you need to select only some files, just use
git mergetool
orgit difftool
after updating. - Flag
--overwrite/-w
disappeared fromcopier update
. It is now implicit. - To update via API,
overwrite=True
is now required. - The default update conflict mode is now
inline
instead ofrej
. - By default, updates now consider 3 lines of context instead of just 1.
- All CLI calls to Copier must now include the subcommand as the 1st argument. For example,
copier
must become nowcopier update
; alsocopier ./tpl ./dst
must becomecopier copy ./tpl ./dst
. - All flags must go after the subcommand now. For example,
copier -r HEAD update ./dst
must now becomecopier update -r HEAD ./dst
orcopier update ./dst -r HEAD
. - Automatic mode removed. Since now subcommands are required, the automatic mode is removed.
- Deprecated
copier.copy
function is removed. Usecopier.run_copy
,copier.run_update
orcopier.run_recopy
explicitly as needed. - default values must be of the same type than the question.
Feat
- disable unsafe features by default and add
--UNSAFE
switch (#1171) - basic nixpkgs overlay
- add
recopy
command and function - support conditional choices (#1010)
- validate default values (#1075)
Fix
- explain better why an answer casting fails
- cli: display subcommand args meaning
- preserver recursive symlinks
- work around Pydantic bug when parsing choices
- skip validating question and generating its default value when its skip condition is met
Refactor
- overwrite always on updates
- update: default to inline markers and 3 lines of context
- remove unused local overrides to answers
v7.2.0 (2023-04-19)
Feat
- customizable update accuracy
Fix
- fix using a branch name as VCS ref
- answer validation for question with complex choices (#1110)
v7.1.0 (2023-04-07)
Feat
- include git in flake app
- support preserving symlinks when copying templates (#938)
- allow imports in inline templates (#986)
- properly support update in repo subdirectory (#1069)
- allow templating
_answers_file
setting (#1027) - let answers file exist in a subdirectory
- validate answers given via CLI/API
- exclude nothing by default when using subdirectory
- add native OS directory separator variable in
_copier_conf.sep
to allow generating
dynamic directory structures - nix support
Fix
- include dirty local changes when copying HEAD
- require answer for questions without default value (#958)
- cleanup: don't clean up local template in parent folder
- delete conditionally created file when answer changes (#982)
- properly support diffs over updates with new interactive answers
- ignore Git hooks during project update (#1066)
- properly support diffs over updates with new answers
- skip tasks in pretend mode (#970)
- parse CLI data using question's answer parser
- don't set YAML
!include
constructor globally (#947) - cli: use
--conflict
flag only incopier update
subcommand - ignore template repo tags that aren't valid PEP 440 versions
- --skip option was ignored (#966)
- Remove useless is_dir check
- don't attempt to render a file if its name is empty
- warn users against using shallow clones as template source
Refactor
- tests: remove unknown timeout marker
- deduplicate code
- remove unused method argument
- simplify casting boolean question settings
- remove useless code related to not asking a question
- typing: use
Mapping
instead ofChainMap
type - move unrelated code out of try-except block
- inline: smarter inline conflict markers algorithm
v7.0.1 (2022-10-14)
Fix
- remove deprecated code scheduled for removal in Copier v7 (#843)
v7.0.0 (2022-10-12)
v6.2.0 (2022-09-18)
Feat
- add validator field to Question (#719)
- support passing github or gitlab urls without the .git suffix (#677)
Fix
- compatibility with pydantic 1.10
- git bundle support breaks with relative paths
- prevent name collision for question var name "value"
Refactor
- add "flake8-simplify" plugin and simplify code
v6.1.0
v6.0.0
All changes here.
Summary:
Added
- Allow using additional Jinja 2 extensions.
- Major version mismatch warning. If your Copier version is too new, you'll be warned.
- Specific exceptions, which will help on error detection for API usages.
- Multiline questions.
- Conditional questions.
- Placeholders.
- Interactive TUI for questionaries. Prompts are way cooler now. 😎
- Python 3.9 support.
- Python 3.10 support.
- Support empty templates suffix, telling Copier to render every file.
- Added
--defaults
flag to use default answers to questions, which might be null if
not specified. - Added
--overwrite
flag to overwrite files that already exist, without asking. - In migration scripts, we have the new environment variables
$VERSION_PEP440_FROM
,
$VERSION_PEP440_CURRENT
and$VERSION_PEP440_TO
, which will always get a valid
PEP440 version identifier, without thev
prefix, allowing your migration scripts
to have a valid standard where to base their logic. - Raise a CopierAnswersInterrupt instead of a bare KeyboardInterrupt to provide
callers with additional context - such as the partially completed AnswersMap. - Support for
user_defaults
, which take precedence over template defaults. - Copy dirty changes from a git-tracked template to the project by default, to make
testing easier. - Advertise clearly which version is being copied or updated in the CLI.
- Add jinja variable
_copier_python
to provide pythonsys.executable
.
Changed
- Fully refactored core.
- Running
copier copy
on a preexisting project now recopies the project instead of
updating it. That means that it respects old answers, but ignores history diff. - We use Jinja 2 defaults now.
{{ }}
instead of[[ ]]
and similar. - We keep trailing newlines by default for Jinja 2 templates.
- Copier will never ask for overwriting the answers file.
- Multi-typed choices follow the same type-casting logic as any other question, so
it's easier to reason about them. However, if you were using this feature, you might
be surprised about its side effects if you don't specify the type explicitly. Just
addtype: yaml
to make it behave mostly as before. Or just don't use that, it's
complicated anyway (warn added to docs). - Changed
--force
to be the same as--defaults --overwrite
. - Copied files will reflect permissions on the same files in the template.
- Copier now uses
git clone --filter=blob:none
when cloning, to be faster. - Removing files from templates will remove them too from the subprojects when they
get updated.
Deprecated
- Deprecated
now
andmake_secret
functions. If your template used those, Copier
will emit warnings leading you on how to upgrade it. - Templates marked with
_min_copier_version
below 6 will still default to use
bracket-based Jinja defaults, but that will disappear soon. If you want your
template to work on Copier 5 and 6, make sure to declare_envops
explicitly in
yourcopier.yaml
. copier.copy()
is confusing, now that actually copying and updating are 2
completely different actions (before, you were actually always updating if
possible). Its direct equivalent is nowcopier.run_auto()
, andcopier.copy()
will disappear in the future.
Removed
- Minimal supported Python version is now 3.7 (dropped Python 3.6 support).
- Removed the
json
method on_copier_conf
. Where you would previously use
_copier_conf.json()
in your templates, please now use_copier_conf|to_json
instead. --subdirectory
flag, which was confusing... and probably useless.- Lots of dead code.
Fixed
- A directory that gets an empty name works as expected: not copied (nor its
contents). - When comparing versions to update, PEP 440 is always used now. This way, we avoid
fake ordering when git commit descriptions happen to be ordered in a non-predictable
way. - Answers file will only remember answers to questions specified in the questionary.