Skip to content

Commit

Permalink
docs(manager/pip-compile): Explicitly describe output file matching (#…
Browse files Browse the repository at this point in the history
…27574)

Co-authored-by: Rhys Arkins <rhys@arkins.net>
  • Loading branch information
peschmae and rarkins committed Feb 28, 2024
1 parent 8c5cbe7 commit baf4657
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions lib/modules/manager/pip-compile/readme.md
Expand Up @@ -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:

Expand Down

0 comments on commit baf4657

Please sign in to comment.