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.

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. Weitere Informationen findest du unter GitHub-Pläne.

Push-Regelsätze sind für den Plan GitHub Team in internen und privaten Repositorys sowie Forks von Repositorys verfügbar, für die Push-Regelsätze aktiviert sind.

In diesem Artikel

Nachdem Sie einen Regelsatz erstellt haben, können Sie Änderungen daran vornehmen. Sie können beispielsweise Regeln hinzufügen, um Ihre Verzweigungen oder Tags besser zu schützen, oder Sie können Ihren Regelsatz Deaktivieren Sie vorübergehend einen Regelsatz, um unbeabsichtigte Auswirkungen auf die Benutzererfahrung Ihres Repositorys zu beheben.

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

Anzeigen von Regelsätzen für ein Repository

Auf der Seite „Rulesets“ können alle Personen mit Lesezugriff auf das Repository die aktiven Regelsätze für einen bestimmten Branch, ein bestimmtes Tag oder eine bestimmte Pusheinschränkung anzeigen.

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 Branch-Namen auf .

    Tipp

    Nur bei Branches mit einem Regelsatz wird neben dem Namen das Symbol angezeigt.

  4. Wenn Sie die Ergebnisse optional filtern möchten, klicken Sie auf die Registerkarten, oder verwenden Sie die Suchleiste „Verzweigungen durchsuchen“.

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

Du kannst auch aktive Regelsätze anzeigen:

  • Indem du das Datenfeld/rules zur URL des Repositorys hinzufügst. Wenn du beispielsweise die Regeln des Open-Source-Dokumentationsrepositorys auf GitHub anzeigen möchtest, navigierst du zuhttps://github.com/github/docs/rules.

  • Im Mergefeld, wenn es Regeln gibt, die das Zusammenführen einer Pull Request blockieren.

Bearbeiten eines Regelsatzes

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“.

Importieren eines Regelsets

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 mindestens anhand eines Regelsatzes überprüft wurden und erfolgreich waren
  • 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 sind diese Erkenntnisse über die REST-API für Regelsammlungen verfügbar.

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

  1. Klicke auf der linken Randleiste unter „Code und Automatisierung“ aufErkenntnisse und dann aufRegelsätze.

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

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

  3. 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.