From 7f46ac38fe30ed2e6ad852aa2c509e16da21841e Mon Sep 17 00:00:00 2001 From: Rhys Arkins <rhys@arkins.net> Date: Wed, 23 Jun 2021 21:37:33 +0200 Subject: [PATCH] docs: rebaseWhen=never clarifications --- docs/usage/configuration-options.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index e6b372a013..62ab4d627d 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -1780,7 +1780,7 @@ By default this label is `"rebase"` however you can configure it to anything you Possible values and meanings: - `auto`: Renovate will autodetect the best setting. Defaults to `conflicted` unless the repository has a setting requiring PRs to be up to date with the base branch -- `never`: Renovate will never rebase the branch +- `never`: Renovate will never rebase the branch or update it unless manually requested - `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 @@ -1789,6 +1789,8 @@ Possible values and meanings: - 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 +It is also recommended to avoid `rebaseWhen=never` as it can result in conflicted branches with outdated PR descriptions and/or status checks. + ## recreateClosed By default, Renovate will detect if it has proposed an update to a project before and not propose the same one again. -- GitLab