docs: fix typo and expand reconfigure doc

This commit is contained in:
Rhys Arkins 2018-07-06 21:04:54 +02:00 committed by GitHub
parent 569037469d
commit bbc78a9963
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,13 +11,15 @@ There will likely be times when you need to change your Renovate config. There a
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 Renovate detects that such a PR includes changes to any of the Renovate configuratino 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.
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
Perhaps you really liked the interactive PR and want to see it again. In that case:
1. Find and rename your original `Configure Renovate` PR (e.g. appending " - old" to the title)
2. Delete your Renovate config from your base branch
1. Find and rename your original `Configure Renovate` PR (e.g. to `Configure Renovate - old`)
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 Configure Renovate PR again. Any existing Renovate PRs 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.