renovatebot-pre-commit-hooks/README.md
carlos-lehmann 9ba47fd09e
docs: Update README with some edge cases (#3092)
Co-authored-by: Michael Kriese <michael.kriese@gmx.de>
2025-09-11 23:47:07 +02:00

1.3 KiB

Renovate pre-commit hooks

A pre-commit hook to run renovate-config-validator when you reconfigure Renovate via PR.

Even though it is a Node-based hook, it works without any system-level dependencies.

Usage

For general usage:

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:

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, for instance to scan for all .json5 files

repos:
  - repo: https://github.com/renovatebot/pre-commit-hooks
    rev: 40.36.8
    hooks:
      - id: renovate-config-validator
        args: [--strict]
        files: '.*\\.json5$'