Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rebaseWhen=conflicted + automerge #9031

Merged
merged 3 commits into from
Mar 8, 2021
Merged

docs: rebaseWhen=conflicted + automerge #9031

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9be65c
docs: rebaseWhen=conflicted + automerge
rarkins Mar 8, 2021
fe60a43
Apply suggestions from code review
rarkins Mar 8, 2021
00cae8c
Merge branch 'master' into docs/rebase-when-conflicted
rarkins Mar 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/usage/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1683,10 +1683,13 @@ 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
- `conflicted`: Renovate will rebase only if the branch is conflicted
- `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 them combined
- 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

Expand Down