From dda7514e209105819dcc19ef451edef6712aa302 Mon Sep 17 00:00:00 2001 From: Rhys Arkins <rhys@arkins.net> Date: Mon, 8 Mar 2021 13:59:05 +0100 Subject: [PATCH] docs: rebaseWhen=conflicted + automerge (#9031) --- docs/usage/configuration-options.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index aa2e68afad..36e2638495 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -1686,7 +1686,10 @@ Possible values and meanings: - `conflicted`: Renovate will rebase only if the branch is conflicted - `behind-base-branch`: Renovate will rebase whenever the branch falls 1 or more commit behind its base branch -Note: this field replaces the previous fields of `rebaseConflictedPrs` and `rebaseStalePrs`. +`rebaseWhen=conflicted` is not recommended if you have enabled Renovate automerge, because: + +- It could result in a broken base branch if two updates are merged one after another without testing the new versions together +- If you have enforced that PRs must be up-to-date before merging (e.g. using branch protection on GitHub), then automerge won't be possible as soon as a PR gets out-of-date but remains non-conflicted ## recreateClosed -- GitLab