Verwalten von Regelsätzen für ein Repository

Sie können vorhandene Regelsätze in einem Repository bearbeiten, überwachen und löschen, um zu ändern, wie Personen mit bestimmten Verzweigungen und Tags interagieren können.

Wer kann dieses Feature verwenden?

Alle Personen mit Lesezugriff auf ein Repository können die Regelsätze des Repositorys anzeigen. Personen mit Adminzugriff auf ein Repository oder mit einer benutzerdefinierten Rolle mit der Berechtigung „edit repository rules“ können Regelsätze für ein Repository erstellen, bearbeiten und löschen sowie Erkenntnisse zu Regelsätzen anzeigen. Weitere Informationen findest du unter Informationen zu benutzerdefinierten Repositoryrollen.

Regelsätze sind verfügbar in öffentlichen Repositorys mit GitHub Free und GitHub Free für Organisationen, und in öffentlichen und privaten Repositorys mit GitHub Pro, GitHub Team und GitHub Enterprise Cloud.

Push-Regelsätze sind für den Plan GitHub Enterprise Cloud in internen und privaten Repositorys, Repositorys mit aktivierten Push-Regelsätzen und Organisationen in Ihrem Unternehmen verfügbar.

In diesem Artikel

Nachdem Sie einen Regelsatz erstellt haben, können Sie Änderungen daran vornehmen. Sie können z. B. Regeln hinzufügen, um Ihre Verzweigungen oder Tags besser zu schützen, oder Sie können Ihr Regelset vom Modus "Auswerten" auf "Aktiv" umstellen, nachdem Sie die Auswirkungen auf die Mitwirkendenerfahrung für Ihr Repository getestet haben zu beheben.

Mit REST und GraphQL APIs kannst du Regelsätze verwalten. Weitere Informationen findest du unter REST-API-Endpunkte für Regeln und Mutationen.

Tipp

Wenn du Besitzer einer Organisation bist, kannst du Regelsätze auf Organisationsebene erstellen. Du kannst diese Regelsätze auf bestimmte Repositorys in deiner Organisation und auf bestimmte Branches in diesen Repositorys anwenden. Weitere Informationen finden Sie unter Erstellen von Regelsätzen für Repositorys in deiner Organisation.

Anzeigen von Regelsätzen für ein Repository

Auf der Seite „Regelsätze“ kann jeder, der Lesezugriff auf das Repository hat, die aktiven Regelsätze einsehen, die auf einen bestimmten Zweig, ein Tag oder eine Push-Einschränkung abzielen. Außerdem werden Regelsätze angezeigt, die im Modus "Auswerten" ausgeführt werden und nicht erzwungen werden.

Für Pushregeln für Fork-Repositorys gibt die Seite „Regelsätze“ an, dass der Regelsatz vom Quell-Repository verwaltet wird, auf das die Regel angewendet wird.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Wähle in der Dateistrukturansicht das Dropdownmenü für Branches aus, und klicke anschließend auf View all branches. Du findest das Branchdropdownmenü auch oben im integrierten Datei-Editor.

    Screenshot der Dateistrukturansicht für ein Repository, Ein Dropdownmenü für Branches ist aufgeklappt und dunkelorange umrandet.

  3. Klicken Sie links neben dem Verzweigungsnamen auf .

    Tipp

    Nur Zweige, die einen Regelsatz haben, haben ein -Symbol neben ihrem Namen.

  4. Um die Ergebnisse optional zu filtern, klicken Sie auf die Registerkarten oder verwenden Sie die Suchleiste "Zweigsuche".

  5. Klicke auf den Namen des Regelsatzes, den du ansehen möchtest.

Sie können auch aktive Ruselets anzeigen:

  • Indem du das Slug /rules zur URL des Repositories hinzufügst. Wenn Sie beispielsweise die Regeln des Open Source Dokumentations-Repositorys unter GitHub anzeigen möchten, wechseln Sie zu https://github.com/github/docs/rules.

  • Im Zusammenführungsfeld, wenn Regeln das Zusammenführen einer Pull-Anfrage blockieren.

Bearbeiten eines Regelsatzes

Hinweis

Wenn ein Regelsatz auf Organisationsebene erstellt wurde, kannst du den Regelsatz nicht über die Einstellungen des Repositorys bearbeiten. Wenn du über die Berechtigung zum Bearbeiten des Regelsatzes verfügst, ist dies in den Einstellungen deiner Organisation möglich. Weitere Informationen finden Sie unter Verwalten von Regelsätzen für Repositorys in deiner Organisation.

Du kannst einen Regelsatz bearbeiten, um Teile darin zu ändern, z. B. den Namen, Umgehungsberechtigungen oder Regeln. Du kannst einen Regelsatz auch bearbeiten, um seinen Status zu ändern. Dies ähnelt dem temporären Aktivieren oder Deaktivieren eines Regelsatzes.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Code und Automatisierung“ auf Regeln und dann auf Regelsätze.

    Screenshot: Randleiste der Seite „Einstellungen“ für ein Repository Das Untermenü „Regeln“ ist erweitert, und die Option „Regelsätze“ ist orange umrandet.

  4. Wähle auf der Seite „Regelsätze“ den Namen des Regelsatzes aus, den du bearbeiten möchtest.

  5. Führe die gewünschten Änderungen aus. Weitere Informationen zu den verfügbaren Regeln findest du unter Verfügbare Regeln für Regelsätze.

  6. Klicke unten auf der Seite auf Änderungen speichern.

Löschen eines Regelsatzes

Tipp

Wenn du einen Regelsatz vorübergehend deaktivieren, aber nicht löschen möchtest, lege dessen Status auf „Disabled“ fest. Weitere Informationen findest du unter Bearbeiten eines Regelsatzes.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Code und Automatisierung“ auf Regeln und dann auf Regelsätze.

    Screenshot: Randleiste der Seite „Einstellungen“ für ein Repository Das Untermenü „Regeln“ ist erweitert, und die Option „Regelsätze“ ist orange umrandet.

  4. Klicke auf den Namen des Regelsatzes, den du löschen möchtest.

  5. Wähle rechts neben dem Namen des Regelsatzes aus, und klicke anschließend auf Delete ruleset.

    Screenshot: Seite zum Bearbeiten eines Regelsatzes Unterhalb einer Schaltfläche mit drei Punkten befindet sich eine orange umrandete Option mit der Bezeichnung „Regelsatz löschen“.

Verwenden des Regelsatzverlaufs

Hinweis

Im Regelsatzverlauf sind ausschließlcih Änderungen enthalten, die nach dem Upgrade auf GitHub Enterprise Server 3.17.0 oder eine höhere Version an einem Regelsatz vorgenommen wurden.

Der Regelsatzverlauf listet Ereignisse auf, die durch Änderungen ausgelöst werden, die sich auf deine Regelsätze innerhalb der letzten 180 Tage auswirken.

Sie können alle Änderungen an einem Regelsatz anzeigen und zu einer bestimmten Iteration zurückkehren. Sie können auch eine JSON-Datei herunterladen, die die Konfiguration des Regelsatzes in einer bestimmten Iteration enthält. Die Umgehungsliste eines Regelsatzes wird aus der exportierten JSON-Datei ausgeschlossen.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Code und Automatisierung“ auf Regeln und dann auf Regelsätze.

    Screenshot: Randleiste der Seite „Einstellungen“ für ein Repository Das Untermenü „Regeln“ ist erweitert, und die Option „Regelsätze“ ist orange umrandet.

  4. Um den Verlauf der Änderungen am Regelsatz anzuzeigen, wähle rechts neben dem Namen des Regelsatzes aus, und klicke dann auf History.

    Screenshot der Seite für Repository-Regelsätze. Unterhalb einer Schaltfläche mit drei Punkten befindet sich eine orange umrandete Option mit der Bezeichnung „Verlauf“.

  5. Wählen Sie rechts neben der jeweiligen Iteration die Option und klicken Sie dann auf Änderungen vergleichen, Wiederherstellen oder Herunterladen.

    Screenshot der Seite für den Repository-Regelgruppenverlauf. Ein beschriftetes 3-Punkte-Dropdown-Menü wird erweitert und durch einem orangefarbenen Rahmen hervorgehoben.

Importieren eines Regelsets

Du kannst einen vorhandenen Regelsatz mithilfe einer JSON-Datei importieren. Dies kann besonders dann hilfreich sein, wenn Sie denselben Regelsatz auf mehrere Repositorys oder Organisationen anwenden möchten.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Code und Automatisierung“ auf Regeln und dann auf Regelsätze.

    Screenshot: Randleiste der Seite „Einstellungen“ für ein Repository Das Untermenü „Regeln“ ist erweitert, und die Option „Regelsätze“ ist orange umrandet.

  4. Wählen Sie das Dropdown-Menü Neues Regelsatz aus, und klicken Sie dann auf Regelsatz importieren.

    Screenshot der Seite für Repository-Regelsätze. Das Dropdownmenü „New ruleset“ ist erweitert, und die Option „Import a ruleset“ ist orange umrandet.

  5. Öffnen Sie die exportierte JSON-Datei.

  6. Überprüfen Sie den importierten Regelsatz und klicken Sie auf Erstellen.

Anzeigen von Erkenntnissen für Regelsätze

Du kannst Erkenntnisse für Regelsätze anzeigen, um zu sehen, wie diese sich auf ein Repository auswirken. Auf der Seite „Regelerkenntnisse“ wird eine Zeitleiste der folgenden Benutzeraktionen angezeigt. Du kannst Filter verwenden, um das Gesuchte zu finden:

  • Aktionen, die mit einem oder mehreren Regelsätzen überprüft und bestanden wurden.
  • Aktionen, die mindestens anhand eines Regelsatzes überprüft wurden und fehlgeschlagen sind
  • Aktionen, bei denen eine Benutzerin mindestens einen Regelsatz umgangen hat

Wenn ein Regelsatz im Modus „Auswerten“ ausgeführt wird, werden Aktionen angezeigt, die erfolgreich gewesen oder fehlgeschlagen wären, wenn der Regelsatz aktiv gewesen wäre.

Darüber hinaus stehen diese Erkenntnisse über die REST-API der Regelsammlungen zur Verfügung.

Screenshot der Seite „Regel-Einblicke“. Drei Aktionen sind aufgelistet und markiert als: „Pass“, „Bypass“ und „Fail“. Die fehlgeschlagene Aktion ist mit der Bezeichnung „evaluate“ versehen.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Code und Automatisierung“ auf Erkenntnisse und dann auf Regelsätze.

    Screenshot: Randleiste der Seite „Einstellungen“ für ein Repository Das Untermenü „Regeln“ ist erweitert, und die Option „Erkenntnisse“ ist orange umrandet.

  4. Verwende oben auf der Seite „Regelerkenntnisse“ die Dropdownmenüs, um die Aktionen nach Regelsatz, Branch, Akteur und Zeitraum zu filtern.

  5. Klicke auf , und erweitere den Namen des Regelsatzes, um zu ermitteln, welche Regeln fehlgeschlagen sind oder für welche Regeln eine Umgehung erforderlich war.

    Screenshot: Seite „Regelerkenntnisse“. Rechts neben einem Ereignis mit der Bezeichnung „not-allowed“ ist das Symbol der drei horizontalen Punkte orange umrandet.

  6. Optional können Sie die Details der Merge-Warteschlange für die entsprechenden Pull Requests in derselben Merge-Gruppe überprüfen.

Verwalten von Anforderungen zum Umgehen von Pushregeln

Sie können alle Anforderungen für Umgehungsberechtigungen auf der Seite „Pushschutz-Umgehung“ anzeigen und verwalten, die sich auf der Registerkarte Regeln des Repositorys befindet.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicken Sie auf Umgehungsanforderungen.

Sie können Anfragen nach Genehmiger (Mitglied der Umgehungsliste), anfordernde Person (Antragsteller), Zeitrahmen und Status filtern. Einer Anforderung werden die folgenden Status zugewiesen:

StatusBeschreibung
CancelledDie Anforderung wurde vom Mitwirkender abgebrochen.
CompletedDie Anforderung wurde genehmigt und der Commit(s) wurde an das Repository verschoben.
DeniedDie Anforderung wurde überprüft und abgelehnt.
ExpiredDie Anforderung ist abgelaufen. Anforderungen sind sieben Tage gültig.
OpenDie Anforderung wurde entweder noch nicht überprüft oder wurde genehmigt, aber der Commit(s) wurde nicht an das Repository verschoben.

Wenn ein Mitwirkender Umgehungsrechte anfordert, um einen Commit zu veröffentlichen, der eingeschränkte Inhalte enthält, erhalten alle Mitglieder der Umgehungsliste eine E-Mail-Benachrichtigung mit einem Link zu der Anforderung. Mitglieder der Umgehungsliste haben dann sieben Tage Zeit, die Anforderung zu überprüfen und zu genehmigen oder zu verweigern, bevor die Anforderung abläuft.

Die Mitwirkender wird per E-Mail über die Entscheidung informiert und muss die erforderlichen Maßnahmen ergreifen. Wenn die Anforderung genehmigt wird, kann der Mitwirkende den Commit, der den eingeschränkten Inhalt enthält, in das Repository stellen. Wird die Anforderung abgelehnt, muss der Mitwirkende den eingeschränkten Inhalt aus dem Commit entfernen, um den Commit erfolgreich in das Repository zu übertragen.