From baf46579c70a0d5485eaaf2d20631ecbca8a65d9 Mon Sep 17 00:00:00 2001 From: Mathias Petermann <mathias.petermann@gmail.com> Date: Wed, 28 Feb 2024 08:09:09 +0100 Subject: [PATCH] docs(manager/pip-compile): Explicitly describe output file matching (#27574) Co-authored-by: Rhys Arkins <rhys@arkins.net> --- lib/modules/manager/pip-compile/readme.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/lib/modules/manager/pip-compile/readme.md b/lib/modules/manager/pip-compile/readme.md index 21719995a8..d7ca06f547 100644 --- a/lib/modules/manager/pip-compile/readme.md +++ b/lib/modules/manager/pip-compile/readme.md @@ -17,15 +17,24 @@ You can "activate" the manager by specifying a `fileMatch` pattern such as: } ``` +`pip-compile` reads the output files to extract the arguments passed to the original command, as such the `fileMatch` must be configured for `*.txt` files and not `*.in`. + ### Assumption of header with a command -If 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: +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-header` option. - Pass all source files explicitly. -In turn `pip-compile` manager will find all source files and parse them as package files. -Currently only `*.in` files associated with `pip_requirements` manager and `setup.py` files associated with `pip_setup` manager are handled. +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 | +| --------------: | ------------------ | +| `setup.py` | `pip_setup` | +| `*.in` | `pip_requirements` | Example header: -- GitLab