Skip to content
Snippets Groups Projects
Unverified Commit baf46579 authored by Mathias Petermann's avatar Mathias Petermann Committed by GitHub
Browse files

docs(manager/pip-compile): Explicitly describe output file matching (#27574)


Co-authored-by: default avatarRhys Arkins <rhys@arkins.net>
parent 8c5cbe70
No related branches found
No related tags found
No related merge requests found
......@@ -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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment