From 863e23e57d0ca32cfbb71090985171ff4775c1f8 Mon Sep 17 00:00:00 2001 From: James Braza Date: Sun, 20 Oct 2024 13:09:04 -0700 Subject: [PATCH] Added links and mentioned --strict --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 751fb043..3e2381b9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ # 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 +17,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] +```