From f9bb814dee8c59ab88147dc303e28a69343fdd71 Mon Sep 17 00:00:00 2001 From: James Braza Date: Thu, 5 Dec 2024 00:22:16 -0800 Subject: [PATCH] docs: Added `README.md` links and documented `--strict` (#2475) --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 324827da..b4c57313 100644 --- a/README.md +++ b/README.md @@ -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] +```