Skip to content

Copier

Categories: python

Renovate supports updating Copier dependencies.

File Matching

By default, Renovate will check any files matching the following regular expression: /(^|/)\.copier-answers(\..+)?\.ya?ml/.

For details on how to extend a manager's managerFilePatterns value, please follow this link.

Supported datasources

This manager supports extracting the following datasources: git-tags.

Dependency types

This manager extracts the following depType values:

depType Description
template Copier project template source

Default config

{
  "managerFilePatterns": [
    "/(^|/)\\.copier-answers(\\..+)?\\.ya?ml/"
  ],
  "versioning": "pep440"
}

Additional Information

Keeps Copier templates up to date. Supports multiple .copier-answers(...).y(a)ml files in a single repository. If a template requires unsafe features, Copier must be invoked with the --trust flag. Enabling this behavior must be allowed in the self-hosted configuration via allowScripts. Actually enable it in the configuration by setting ignoreScripts to false.

If you need to change the versioning format, read the versioning documentation to learn more.

Private Modules Authentication

To look up new template versions, Renovate converts SSH-style _src_path URLs (like git+ssh://git@gitlab.com/some-org/some-template.git) to their HTTPS equivalent, the same way the git-submodules manager does. This way the lookup works with hostRules credentials on setups which access the Git host via HTTPS only. The answers file itself keeps the original URL.

Before running the copier command to update from the template, Renovate exports git insteadOf directives in environment variables.

Renovate uses this logic before it updates the template copy:

The token from the hostRules entry matching hostType=github and matchHost=api.github.com is added as the default authentication for github.com. For those running against github.com, this token will be the default platform token.

Next, all hostRules with both a token or username/password and matchHost will be fetched, except for any github.com one from above.

Rules from this list are converted to environment variable directives if they match any of these characteristics:

  • No hostType is defined, or
  • hostType is git-tags, or
  • hostType is a platform (github, gitlab, azure, etc.)