mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-30 17:27:26 +00:00
Matthias Schoettle
e70495f08a
* docs: fix indent in pre-commit hook example for Go * use single quotes
75 lines
2.4 KiB
Markdown
75 lines
2.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 `managerFilePatterns` 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.
|
|
|
|
### Additional Dependencies
|
|
|
|
Renovate has partial support for `additional_dependencies`, currently Go, Node.js and Python only.
|
|
|
|
You will need to **explicitly add the language** to your hooks with `additional_dependencies` to let Renovate know
|
|
what kind of dependencies they are.
|
|
|
|
Examples for the supported languages are listed below.
|
|
|
|
#### Go
|
|
|
|
```yaml
|
|
- repo: https://github.com/rhysd/actionlint
|
|
rev: v1.7.7
|
|
hooks:
|
|
- id: actionlint
|
|
language: golang
|
|
additional_dependencies:
|
|
- 'github.com/wasilibs/go-shellcheck/cmd/shellcheck@v0.10.0'
|
|
```
|
|
|
|
#### Node.js
|
|
|
|
```yaml
|
|
- repo: https://github.com/pre-commit/mirrors-prettier
|
|
rev: v3.1.0
|
|
hooks:
|
|
- id: prettier
|
|
language: node
|
|
additional_dependencies:
|
|
- '@trivago/prettier-plugin-sort-imports@^5.2.2'
|
|
- prettier@^3.6.2
|
|
```
|
|
|
|
#### Python
|
|
|
|
```yaml
|
|
- repo: https://github.com/psf/black
|
|
rev: 19.3b0
|
|
hooks:
|
|
- id: black
|
|
language: python
|
|
additional_dependencies:
|
|
- 'requests==1.1.1'
|
|
```
|