About branch protection rules
You can create a branch protection rule in a repository for a specific branch, all branches, or any branch that matches a name pattern you specify with fnmatch
syntax. For example, to protect any branches containing the word release
, you can create a branch rule for *release*
.
You can create a rule for all current and future branches in your repository with the wildcard syntax *
. GitHubは、File.fnmatch
構文に File::FNM_PATHNAME
フラグを使用するので、ワイルドカードはディレクトリの区切り文字 (/
) には一致しません。 たとえば、qa/*
は、qa/
で始まり、1 つのスラッシュが含まれるすべてのブランチにマッチします。 You can include multiple slashes with qa/**/*
, and you can extend the qa
string with qa**/**/*
to make the rule more inclusive. ブランチのルールに関する構文オプションの詳しい情報については、 fnmatch ドキュメンテーションを参照してください。
リポジトリが同じブランチに影響する複数の保護されたブランチのルールを持っているなら、特定のブランチ名を含むルールがもっとも高い優先順位を持ちます。 同じ特定のブランチ名を参照する保護されたブランチのルールが複数あるなら、最初に作成されたブランチルールが高い優先順位を持ちます。
*
、?
、]
などの特殊文字を含む保護されたブランチのルールは、作成された順序で適用されるので、これらの文字を持つ古いルールが高い優先順位を持ちます。
既存のブランチのルールに例外を作成するため、特定のブランチ名に対するルールなど、優先度の高いブランチ保護ルールを新しく作成できます。
For more information about each of each of the available branch protection settings, see "About protected branches."
Creating a branch protection rule
When you create a branch rule, the branch you specify doesn't have to exist yet in the repository.
- GitHub Enterprise Serverで、リポジトリのメインページにアクセスしてください。
- リポジトリ名の下で Settings(設定)をクリックしてください。
- 左のメニューでBranches(ブランチ)をクリックしてください。
- "Branch protection rules(ブランチ保護のルール)"の隣のAdd rule.(ルールの追加)をクリックしてください。
- "Branch name pattern(ブランチ名のパターン)"の下で、保護したいブランチの名前もしくはパターンを入力してください。
- Optionally, enable required pull request reviews.
- Under "Protect matching branches", select Require pull request reviews before merging.
- Click the Required approving reviews drop-down menu, then select the number of approving reviews you'd like to require on the branch.
- Optionally, to dismiss a pull request approval review when a code-modifying commit is pushed to the branch, select Dismiss stale pull request approvals when new commits are pushed.
- Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select Require review from Code Owners. 詳細は「コードオーナーについて」を参照してください。
- Optionally, if the repository is part of an organization, select Restrict who can dismiss pull request reviews. Then, search for and select the people or teams who are allowed to dismiss pull request reviews. 詳しい情報についてはプルリクエストレビューの却下を参照してください。
- Optionally, enable required status checks.
- [Require status checks to pass before merging] を選択します。
- Optionally, to ensure that pull requests are tested with the latest code on the protected branch, select Require branches to be up to date before merging.
- 使用可能なステータスチェックのリストから、必須とするものを選択します。
- Optionally, select Require signed commits.
- Optionally, select Require linear history.
- オプションとして、[Include administrators] を選択します。
- Optionally, enable branch restrictions.
- Select Restrict who can push to matching branches.
- Search for and select the people, teams, or apps who will have permission to push to the protected branch.
- Optionally, under "Rules applied to everyone including administrators", select Allow force pushes.
- Optionally, select Allow deletions.
- Create(作成)をクリックしてください。
Editing a branch protection rule
- GitHub Enterprise Serverで、リポジトリのメインページにアクセスしてください。
- リポジトリ名の下で Settings(設定)をクリックしてください。
- 左のメニューでBranches(ブランチ)をクリックしてください。
- To the right of the branch protection rule you want to edit, click Edit.
- Make your desired changes to the branch protection rule.
- [Save changes] をクリックします。
Deleting a branch protection rule
- GitHub Enterprise Serverで、リポジトリのメインページにアクセスしてください。
- リポジトリ名の下で Settings(設定)をクリックしてください。
- 左のメニューでBranches(ブランチ)をクリックしてください。
- To the right of the branch protection rule you want to delete, click Delete.