Managing a branch protection rule

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 *. Weil GitHub das File::FNM_PATHNAME-Flag für die File.fnmatch-Syntax verwendet, wird der Platzhalter das Verzeichnistrennzeichen (/) nicht abgleichen. Zum Beispiel wird qa/* alle Branches mit qa/ abgleichen und einen einzigen Schrägstrich enthalten. You can include multiple slashes with qa/**/*, and you can extend the qa string with qa**/**/* to make the rule more inclusive. Weitere Informationen zu den Syntax-Optionen für Branch-Regeln findest Du in der fnmatch-Dokumentation.

Wenn es für ein Repository mehrere Regeln für geschützte Branches gibt, die dieselben Branches betreffen, haben die Regeln, die einen spezifischen Branch-Namen enthalten, die höchste Priorität. Wenn es mehr als eine Regel für geschützte Branches gibt, die auf den gleichen spezifischen Branch-Namen verweist, hat die zuerst erstellte Branch-Regel eine höhere Priorität.

Regeln für geschützte Branches mit einem Sonderzeichen, wie *, ? oder ], werden in der Reihenfolge ihrer Erstellung angewendet, sodass ältere Regeln mit diesen Zeichen eine höhere Priorität haben.

Um eine Ausnahme für eine vorhandene Branch-Regel zu erstellen, erstellst Du eine neue Branch-Schutzregel mit höherer Priorität, z. B. eine Branch-Regel für einen bestimmten Branch-Namen.

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.

1. Navigiere in GitHub Enterprise Server zur Hauptseite des Repository.
2. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen).
3. Klicke im linken Menü auf Branches.
4. Klicke neben „Branch protection rules" (Branch-Schutzregeln) auf Add rule (Regel hinzufügen.)
5. Gib unter „Branch name pattern" (Branch-Namensmuster) den Branch-Namen oder das Muster ein, das Du schützen möchtest.
6. 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. Weitere Informationen findest Du unter „Über Codeinhaber."
   • 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. Weitere Informationen findest Du unter „Einen Pull-Request-Review ablehnen.“
7. Optionally, enable required status checks.
   • Aktivieren Sie Require status checks to pass before merging (Statuschecks müssen vor dem Mergen bestanden werden).
   • 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.
   • Wähle aus der Liste der verfügbaren Statuschecks diejenigen Prüfungen, die Du verlangen willst.
8. Optionally, select Require signed commits.
9. Optionally, select Require linear history.
10. Optional wähle Include administrators (Administratoren einbeziehen) aus.
11. 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.
12. Optionally, under "Rules applied to everyone including administrators", select Allow force pushes.
13. Optionally, select Allow deletions.
14. Klicke auf Create (Erstellen).

Editing a branch protection rule

1. Navigiere in GitHub Enterprise Server zur Hauptseite des Repository.
2. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen).
3. Klicke im linken Menü auf Branches.
4. To the right of the branch protection rule you want to edit, click Edit.
5. Make your desired changes to the branch protection rule.
6. Klicke auf Save changes (Änderungen speichern).

Deleting a branch protection rule

1. Navigiere in GitHub Enterprise Server zur Hauptseite des Repository.
2. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen).
3. Klicke im linken Menü auf Branches.
4. To the right of the branch protection rule you want to delete, click Delete.