mirror of
https://github.com/renovatebot/pre-commit-hooks.git
synced 2026-04-05 06:16:54 +00:00
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# Renovate pre-commit hooks
|
|
|
|
A [pre-commit](https://pre-commit.com/) hook to run [`renovate-config-validator`](https://docs.renovatebot.com/config-validation/#config-validation) when you [reconfigure Renovate via PR](https://docs.renovatebot.com/getting-started/installing-onboarding/#reconfigure-via-pr).
|
|
|
|
Even though it is a Node-based hook, it works [without any system-level dependencies](https://pre-commit.com/#node).
|
|
|
|
## Usage
|
|
|
|
For general usage:
|
|
|
|
```yaml
|
|
repos:
|
|
- repo: https://github.com/renovatebot/pre-commit-hooks
|
|
rev: 41.100.0
|
|
hooks:
|
|
- id: renovate-config-validator
|
|
```
|
|
|
|
Or for a tighter configuration,
|
|
opt into [strict mode](https://docs.renovatebot.com/config-validation/#strict-mode):
|
|
|
|
```yaml
|
|
repos:
|
|
- repo: https://github.com/renovatebot/pre-commit-hooks
|
|
rev: 41.100.0
|
|
hooks:
|
|
- id: renovate-config-validator
|
|
args: [--strict]
|
|
```
|
|
|
|
If you run into Heap Size issues try to set ENV `NODE_OPTIONS` with value `"--max-old-space-size=4096"`.
|
|
|
|
## Override hook configuration
|
|
|
|
You can override the configuration in [pre-commit-hooks.yaml](.pre-commit-hooks.yaml), for instance to scan for all `.json5` files
|
|
|
|
```yaml
|
|
repos:
|
|
- repo: https://github.com/renovatebot/pre-commit-hooks
|
|
rev: 40.36.8
|
|
hooks:
|
|
- id: renovate-config-validator
|
|
args: [--strict]
|
|
files: '.*\\.json5$'
|
|
```
|