Skip to content

Commit

Permalink
docs(config options): automerge and GitHub branch protection rule (#…
Browse files Browse the repository at this point in the history
…25810)

Co-authored-by: Oliver Salzburg <oliver.salzburg@protonmail.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
  • Loading branch information
3 people authored Nov 16, 2023
1 parent 1bbb7eb commit 6b90dd7
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/usage/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,16 @@ So for example you could choose to automerge all (passing) `devDependencies` onl
Renovate tries to delay until Azure is in the expected state, but it will continue if it takes too long.
In some cases this can result in a dependency not being merged, and a fresh PR being created for the dependency.

**Automerge and GitHub branch protection rules**

You must select at least one status check in the _Require status checks to pass before merging_ section of your branch protection rules on GitHub, if you match all three conditions:

- `automerge=true`
- `platformAutomerge=true`, Renovate defaults to `true`
- You use use GitHub's _Require status checks to pass before merging_ branch protection rule

If you don't select any status check, and you use platform automerge, then GitHub might automerge PRs with failing tests!

## automergeComment

Use this only if you configure `automergeType="pr-comment"`.
Expand Down

0 comments on commit 6b90dd7

Please sign in to comment.