diff --git a/docs/usage/reconfigure-renovate.md b/docs/usage/reconfigure-renovate.md index 3218a552e21ce05ffd669e8a0e1b38be02a6f73c..e8fef1e0f16d7ac234a4245499d36ee9c8a89eac 100644 --- a/docs/usage/reconfigure-renovate.md +++ b/docs/usage/reconfigure-renovate.md @@ -9,11 +9,7 @@ There will likely be times when you need to change your Renovate config. There a ## 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. - -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. +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. ## 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 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.