docs: Added README.md links and documented --strict (#2475)

This commit is contained in:
James Braza 2024-12-05 00:22:16 -08:00 committed by GitHub
parent dbecf48408
commit f9bb814dee
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,11 +1,13 @@
# Renovate pre-commit hooks
A [pre-commit](https://pre-commit.com/) hook to run `renovate-config-validator` when you [reconfigure Renovate via PR](https://docs.renovatebot.com/getting-started/installing-onboarding/#reconfigure-via-pr).
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
@ -13,3 +15,15 @@ repos:
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: 38.128.6
hooks:
- id: renovate-config-validator
args: [--strict]
```