Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add config-validation chapter (#21969)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
- Loading branch information
1 parent
85631e8
commit ad78e85
Showing
4 changed files
with
29 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: Config Validation | ||
description: How to validate Renovate's configuration. | ||
--- | ||
|
||
# Config Validation | ||
|
||
All [`renovate` distributions](getting-started/running.md#available-distributions) contain a standalone validator program (`renovate-config-validator`) that can be used to validate Renovate's configuration. | ||
|
||
The validator program checks files passed as CLI arguments. | ||
If no argument is given, all [default locations](configuration-options.md) (if files exist) and the `RENOVATE_CONFIG_FILE` environment variable are checked. | ||
|
||
```console | ||
$ npm install --global renovate | ||
added 750 packages, and audited 751 packages in 51s | ||
$ renovate-config-validator | ||
INFO: Validating renovate.json | ||
INFO: Config validated successfully | ||
``` | ||
|
||
You can configure a [pre-commit](https://pre-commit.com) hook to validate your configuration automatically. | ||
Please check out the [`renovatebot/pre-commit-hooks` repository](https://github.com/renovatebot/pre-commit-hooks) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters