renovate/lib/modules/manager/pre-commit/readme.md

29 lines
1.4 KiB
Markdown

_Important note_: The `pre-commit` manager is disabled by default and must be opted into through config.
Renovate's approach to version updating is not fully aligned with `pre-commit autoupdate` and this has caused frustration for `pre-commit`'s creator/maintainer.
Attempts to work with the `pre-commit` project to fix these gaps have been rejected, so we have chosen to disable the manager by default indefinitely.
Please do not contact the `pre-commit` project/maintainer about any Renovate-related topic.
To view a list of open issues related to the `pre-commit` manager in Renovate, see the [filtered list using the `manager:pre-commit` label](https://github.com/renovatebot/renovate/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Amanager%3Apre-commit).
When enabled, Renovate supports updating of Git dependencies within pre-commit configuration `.pre-commit-config.yaml` files or other YAML files that use the same format (via `fileMatch` configuration).
Updates are performed if the files follow the conventional format used in typical pre-commit files:
```yaml
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v1.0.0
hooks:
- id: some-hook-id
```
To enable the `pre-commit` manager, add the following config:
```json
{
"pre-commit": {
"enabled": true
}
}
```
Alternatively, add `:enablePreCommit` to your `extends` array.