Skip to content

Commit

Permalink
Add some clarifications on how branch protections work.
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuss authored and Mark-Simulacrum committed Nov 10, 2023
1 parent f2548ea commit 78a3388
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/toml-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ name = "my-repo"
# A description of the repo (required)
description = "A repo for awesome things!"
# The bots that this repo requires (required)
bots = ["bors", "highfive", "rustbot", "rust-timer"]
bots = ["bors", "rustbot", "rust-timer"]

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

0 comments on commit 78a3388

Please sign in to comment.