diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md index 4cd71ea56d8ce0f323709a25132ffbc4e6ae74f4..b887f69a957be5f994479ccb98c7cefc44f58356 100644 --- a/website/docs/configuration-options.md +++ b/website/docs/configuration-options.md @@ -71,16 +71,16 @@ Example use: This setting is only applicable if you opt in to set `automerge` to `true` for any of your dependencies. -Automerging defaults to doing to using Pull Requests (`automergeType="pr"`), i.e. Renovate first creates a branch, then an associated Pull Request, and then automerges the first time it detects that the Pull Requests status checks are "green". Note: if you have no tests and still want to automerge, don't forget to configure `requiredStatusChecks=null`. +Automerging defaults to using Pull Requests (`automergeType="pr"`). In that case Renovate first creates a branch, then an associated Pull Request, and then automerges the first time it detects that the Pull Requests status checks are "green". Note: if you have no tests and still want to automerge, don't forget to configure `"requiredStatusChecks": null`. -If you prefer that Renovate more silently automerge _without_ Pull Requests at all, you can set `automergeType="branch"`. In this case Renovate will: +If you prefer that Renovate more silently automerge _without_ Pull Requests at all, you can set `"automergeType": "branch"`. In this case Renovate will: -- Create the branch +- Create the branch, wait for test results - Rebase it any time it gets out of date with the base branch -- Automerge it if it's (a) up-to-date, and (b) passing all tests -- As a backup, raise a PR only if either tests fail, or they remain pending for too long (default: 24 hours) +- Automerge the branch commit if it's: (a) up-to-date with the base branch, and (b) passing all tests +- As a backup, raise a PR only if either: (a) tests fail, or (b) tests remain pending for too long (default: 24 hours) -The final value for `automergeType` is `pr-comment`, intended only for users who already have a "merge bot" such as [bors-ng](https://github.com/bors-ng/bors-ng) and want Renovate to _not_ actually automerge by itself and instead tell `bors-ng` to merge for it, by using a comment in the PR. If you're not already using `bors-ng` or similar, don't worry about this option. +The final value for `automergeType` is `"pr-comment"`, intended only for users who already have a "merge bot" such as [bors-ng](https://github.com/bors-ng/bors-ng) and want Renovate to _not_ actually automerge by itself and instead tell `bors-ng` to merge for it, by using a comment in the PR. If you're not already using `bors-ng` or similar, don't worry about this option. ## azureAutoComplete