Sebastian Poxhofer
4b4d14ec00
* feat(manager): pass extracted constraints to updateArtifacts `extractedConstraints` were collected during extraction but only ever read by `fetch.ts` for the lookup. At artifact time every manager had to derive the same tool constraints a second time, and when the updated package file no longer carried the constraint there was nothing to fall back to. `generateBranchConfig()` now merges the `extractedConstraints` of all upgrades of a branch onto the branch config, which reaches `updateArtifacts()` through `patchConfigForArtifactsUpdate()`. `UpdateArtifactsConfig` declares the field and documents what it contains. The new `resolveToolConstraint()` helper implements the ladder once: user `constraints` > an optional artifact-time derivation > the extracted value. The derivation is ranked above the extracted value on purpose: it reads the package files as the branch changed them, so poetry (python is an updatable dependency there), composer, pipenv (`pipenv` can be a dev package) and pep621 (`requires-python` is an updatable dependency) would otherwise regress to a stale constraint. pipenv, pep621 uv/pdm, poetry and composer are migrated to the helper and keep their derivation. Behaviour change: these managers now use the extract-time constraint as a last resort instead of running unconstrained, for example on lock file maintenance where pipenv deletes `Pipfile.lock` before deriving. `execute-post-upgrade-commands.ts` is unaffected: it reads `upgrade.constraints` per upgrade, and the extracted values are kept in a separate field rather than folded into `constraints`, so post-upgrade task tool constraints still come from user config only. Not migrated, because their constraints are never extracted, so the fallback would be dead code: bundler (`ruby`/`bundler`), pixi (`pixi`), pep621 uv (`required-version`) and npm's node ladder, whose last step already reads `package.json` engines. * refactor(manager): resolve tool constraints through resolveToolConstraint() Every manager now obtains the constraint of a tool it runs through `resolveToolConstraint()` instead of reading `config.constraints` itself, so the precedence "user config, then a value derived from the updated files, then the constraints collected during extraction" applies everywhere. The helper treats an empty string as not set at every step and accepts the `PostUpdateConfig` shape, whose `constraints` may be `null`. Behaviour changes that go beyond the new fallback to extracted constraints: - `mix` applies its hardcoded erlang default only after the extracted constraint, so an erlang version collected at extraction can win over it. - `kustomize` decides `HELM_EXPERIMENTAL_OCI` from the fully resolved helm constraint; `generateHelmEnvs()` takes that value instead of the config. - `npm` (yarn): an upgrade of yarn without a new value now consults the user constraint before deriving one from package.json or the lock file. - The "Using <tool> constraint from config" debug lines in bundler, composer, copier and pip-compile are gone, as the helper is the only reader of the config now. Helpers that read the config synchronously became async: bundler `getBundlerConstraint()`, copier `getPythonVersionConstraint()` and `getCopierVersionConstraint()`, pip-compile `get*VersionConstraint()` and `getToolVersionConstraint()`, gomod `deriveGoToolchainConstraints()` and `getUpdateImportPathCmds()`, mise `getMiseLockToolConstraints()`. composer `getPhpConstraint()` is removed. Each converted manager has a test showing the extracted constraint reaching the executed tool, and, where a derive callback exists, that the derived value still wins over it. * refactor(linters): add prefer-resolve-tool-constraint rule Reports member reads and destructuring of `constraints` and `extractedConstraints` from a manager config in `lib/modules/manager/**`, so that tool constraints are resolved through `resolveToolConstraint()` in `lib/modules/manager/util.ts` only. Writes and the same properties on package files, which extraction has to populate, are not reported. The helper itself and spec files are exempt in `.oxlintrc.json`. * refactor(manager): inline thin resolveToolConstraint wrappers Drop copier/utils.ts and the pip-compile getPipToolsVersionConstraint / getUvVersionConstraint helpers, which only forwarded to resolveToolConstraint(). Callers now call it directly. * docs(development): note lock file maintenance in tool constraints section * refactor(manager): address review on tool constraint resolution composer only runs extractConstraints() when a user constraint is missing, via Lazy. UpdateArtifactsConfig no longer re-declares constraints and extractedConstraints, which ToolConstraintsConfig already provides.
The pip-compile manager does not support all use cases for pip-compile, so if you find any areas lacking and without an existing Issue then please "Suggest an Idea" in the Discussions forum with your use case.
The uv pip compile command is also supported through this manager in the same fashion as pip-compile.
The current implementation has some limitations.
Read the full document before you start using the pip-compile manager.
Non-configured managerFilePatterns
The pip-compile manager has an empty array for default managerFilePatterns, meaning it won't match any files ever by default.
You can "activate" the manager by specifying a managerFilePatterns pattern such as:
{
"pip-compile": {
"managerFilePatterns": ["/(^|/)requirements\\.txt$/"]
}
}
pip-compile reads the output files to extract the arguments passed to the original command, as such the managerFilePatterns must be configured for *.txt files and not *.in.
Assumption of header with a command
As Renovate matches a pip-compile output file it will extract original command that was used to create it from header in this file.
Because of that pip-compile manager poses restrictions on how this file is generated:
- Use default header generation, don't use
--no-headeroption. - Pass all source files explicitly.
In turn pip-compile manager will find all source files and parse them as package files using their respective managers.
The following files are currently supported:
| Source filename | Manager |
|---|---|
pyproject.toml |
pep621 |
setup.py |
pip_setup |
*.in |
pip_requirements |
Example header:
#
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile --no-emit-index-url --output-file=requirements.txt requirements.in
#
Conflicts with other managers
Because pip-compile will update source files with their associated manager you should disable them to avoid running these managers twice.
{
"pip_requirements": {
"enabled": false
},
"pip_setup": {
"enabled": false
}
}
Configuration of Python version
By default Renovate extracts Python version from the header for pip-compile, and from the --python-version option for uv.
To get Renovate to use another version of Python, add a constraints` rule to the Renovate config:
{
"constraints": {
"python": "==3.7"
}
}
pip-compile arguments
Renovate reads the requirements.txt file and extracts these pip-compile arguments:
- source files as positional arguments
--output-file
All other allowed pip-compile arguments will be passed over without modification.
Transitive / indirect dependencies
This manager detects dependencies that only appear in lock files.
They are disabled by default but can be forced to enable by vulnerability alerts.
They will be upgraded with --upgrade-package option.