Skip to content

Commit 78a3388

Browse files
ehussMark-Simulacrum
authored andcommitted
Add some clarifications on how branch protections work.
1 parent f2548ea commit 78a3388

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/toml-schema.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ name = "my-repo"
237237
# A description of the repo (required)
238238
description = "A repo for awesome things!"
239239
# The bots that this repo requires (required)
240-
bots = ["bors", "highfive", "rustbot", "rust-timer"]
240+
bots = ["bors", "rustbot", "rust-timer"]
241241

242242
# The teams that have access to this repo along
243243
# with the access level. (required)
@@ -261,6 +261,24 @@ octocat = "write"
261261
# The branch protections (optional)
262262
# Refer to https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches
263263
# for information on how branch protections work.
264+
#
265+
# The behavior depends on whether or not bors is enabled.
266+
# If bors is not enabled, then this requires at least one approving review
267+
# (via GitHub's PR UI).
268+
# If bors is enabled, approvals via GitHub's UI is not required (since we
269+
# count the `@bors r+` comment as an approval). Also, bors will be added to
270+
# the "allowed pushers".
271+
#
272+
# Users with the "maintain" role or admins are allowed to merge PRs via the
273+
# GitHub UI. If you have bors enabled, you should only give users the "write"
274+
# role so that the "Merge" button is disabled, forcing the user to use the
275+
# `@bors r+` comment instead.
276+
#
277+
# The branch protection also requires a PR to push changes. You cannot push
278+
# directly to the branch.
279+
#
280+
# Admins cannot override these branch protections. If an admin needs to
281+
# do that, they will need to temporarily edit the branch protection.
264282
[[branch-protections]]
265283
# The pattern matching the branches to be protected (required)
266284
pattern = "master"

0 commit comments

Comments
 (0)