renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 06:56:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

docs: update config validation

Browse source
This commit is contained in:
Rhys Arkins 2020-05-28 19:23:41 +02:00
parent a1e025681c
commit 21b606e791
1 changed files with 1 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/usage/reconfigure-renovate.md
View file

@ -9,11 +9,7 @@ There will likely be times when you need to change your Renovate config. There a
## Reconfigure via PR ## Reconfigure via PR
Create a PR that includes "Renovate" in its title, e.g. "Reconfigure Renovate" or "Update Renovate Configuration". Doing so will flag it to Renovate the next time it runs. If you wish to make config edits directly, it's recommended to do so via a PR and then run Renovate's config validator to verify it. The validator is named `renovate-config-validator` and installed alongside `renovate` itself if you run `npm i -g renovate` or equivalent. If it validates your new config then it should be safe to merge.
Important: Do not use the same branch prefix as Renovate uses, e.g. do not use `renovate/reconfigure`. Renovate assumes that it "owns" the branch prefix and that any excess branches should be cleaned up as they are no longer needed. Instead, name it like `chore/reconfigure-renovate`.
If Renovate detects that such a PR includes changes to any of the Renovate configuration files (e.g. `renovate.json`) then it will run its validation against this new config and set a status check result of "success" if it passes or "failed" if it does not. This way you can be sure that your config is at least valid before merging.
## Nuke config and re-onboard ## Nuke config and re-onboard
@ -23,5 +19,3 @@ Perhaps you really liked the interactive PR and want to see it again. In that ca
2. Delete your Renovate config (e.g. `renovate.json`) from your base branch 2. Delete your Renovate config (e.g. `renovate.json`) from your base branch
This will be enough to trick Renovate into thinking that the repository was _never_ onboarded and it will trigger a new Configure Renovate PR again. Any existing Renovate PRs in progress may be closed, however. This will be enough to trick Renovate into thinking that the repository was _never_ onboarded and it will trigger a new Configure Renovate PR again. Any existing Renovate PRs in progress may be closed, however.
Be aware that re-onboarding via the interactive PR is currently not supported for Bitbucket Server or Azure DevOps since they do not allow editing or removing merged PRs.