update rebaseWhen docs and update text in Renovate PR body

[HonkingGoose]

What would you like Renovate to be able to do?

I'm rescuing this from the discussion (#8982) to prevent this from being missed later on.

As far as I can see from the discussion there, there's a problem with the current descriptions in the docs on rebaseWhen.

It seems that the docs are not up-to-date with the current behavior of the bot anymore, as @viceice explained:

default is rebaseWhen=auto which will rebase all automerge pr's / branches by default. All other are only rebased on conflict.

This is the recent change we made. so renovate is able to rebase automerge pr, so it's not stopped by up-to-date branch protection

@rarkins also said that:

We should make sure that the description in the PR matches as well, to explain that stale rebasing is necessary if automerge is enabled.

Did you already have any implementation ideas?

• Update docs (573de66 and PR docs: update rebasing documentation #9021)
• Update Renovate PR body text (make sure that the description in the PR matches as well, to explain that stale rebasing is necessary if automerge is enabled.)

[HonkingGoose]

@rarkins and @viceice I'm not totally clear on what needs changing here, so feel free to expand on the requirements.

[HonkingGoose]

Putting this at priority-3-normal as what we have now seems to confuse our users. 😄

#8982 (reply in thread)

[HonkingGoose]

Question for @rarkins: didn't you also want to update the Renovate bot PR body text? I noticed you've closed this issue with PR #9031 but that was a docs: change only.

[renovate-release]

🎉 This issue has been resolved in version 24.77.1 🎉

The release is available on:

• GitHub release
• 24.77.1

Your semantic-release bot 📦🚀