Skip to main content

Managing code rulesets for repositories in your enterprise

You can edit, monitor, and delete existing rulesets to alter how people can interact with repositories in your enterprise.

Wer kann dieses Feature verwenden?

Enterprise owners

After creating a ruleset at the enterprise level, you can make changes to the ruleset to alter how people can interact with the targeted repositories. For example, you can:

  • Add rules to better protect the branches or tags in those repositories
  • Switch your ruleset from "Evaluate" mode to "Active" after testing its effects on the contributor experience

Note

Alle Personen mit Lesezugriff auf ein Repository können die aktiven Regelsätze für dieses Repository anzeigen.

About delegated bypass

Note

Die delegierte Umgehung für Push-Regeln befindet sich derzeit in der public preview und kann noch geändert werden.

Mit der delegierten Umgehung von Push-Regelsätzen können Sie steuern, wer den Push-Schutz umgehen kann und welche gesperrten Pushs zugelassen werden sollen.

Mit delegierter Umgehung müssen Mitwirkende eines Repositorys „Rechte umgehen“ anfordern, wenn Commits mit eingeschränktem Inhalt übertragen werden. Die Anforderung wird an eine bestimmte Gruppe von Prüfern gesendet, die die Anforderung zum Umgehen der Pushregeln genehmigen oder verweigern.

Wenn die Anforderung, Pushregeln zu umgehen, genehmigt wird, kann der Mitwirkende den Commit, der den eingeschränkten Inhalt enthält, pushen. Wenn die Anforderung abgelehnt wird, muss der Mitwirkende den Inhalt aus den Commits) entfernen, die die eingeschränkten Inhalte enthalten, bevor er es erneut veröffentlicht.

Um die delegierte Umgehung zu konfigurieren, erstellen Organisationsbesitzer oder Repositoryadministratoren zuerst eine „Umgehungsliste.“ Die Umgehungsliste umfasst bestimmte Rollen und Teams, z. B. Team- oder Repositoryadministratoren, die Anforderungen zum Umgehen des Pushschutzes überwachen. Weitere Informationen findest du unter Verwalten von Regelsätzen für Repositorys in deiner Organisation und Informationen zu Regelsätzen.

Editing a ruleset

You can edit a ruleset to change parts of the ruleset, such as the name, bypass permissions, or rules. You can also edit a ruleset to change its status, such as if you want to enable or temporarily disable a ruleset.

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.

  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.

  3. In the left sidebar, in the "Policies" section, click Code, then click Rulesets.

  4. On the "Rulesets" page, click the name of the ruleset you want to edit.

  5. Change the ruleset as required.

    For information on the available rules, see "Verfügbare Regeln für Regelsätze"

  6. At the bottom of the page, click Save changes.

Deleting a ruleset

Note

Alle Personen mit Lesezugriff auf ein Repository können die aktiven Regelsätze für dieses Repository anzeigen.

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.
  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.
  3. In the left sidebar, in the "Policies" section, click Code, then click Rulesets.
  4. To the right of the ruleset's name, select , then click Delete ruleset.

Using ruleset history

Note

  • Die Regelsatzhistorie befindet sich derzeit in public preview und kann geändert werden.
  • Im Regelsatzverlauf sind nur Änderungen, die nach der public preview-Veröffentlichung am 11. Oktober 2023 vorgenommen wurden, enthalten.

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. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.
  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.
  3. In the left sidebar, in the "Policies" section, click Code, then click Rulesets.
  4. To view the history of changes to the ruleset, select to the right of the ruleset's name, then click History.
  5. To the right of the specific iteration, select , then click Compare changes, Restore, or Download.

Importing a ruleset

You can import a ruleset from another repository, organization or enterprise using the exported JSON file from the previous section. This can be useful if you want to apply the same ruleset to multiple repositories, organizations or enterprises.

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.
  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.
  3. In the left sidebar, in the "Policies" section, click Code, then click Rulesets.
  4. Select the New ruleset dropdown, then click Import a ruleset.
  5. Open the exported JSON file.
  6. Review the imported ruleset and click Create.

Viewing insights for rulesets

You can view insights for rulesets to see how rulesets are affecting the repositories in your enterprise. 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.

Screenshot: Seite „Regelerkenntnisse“. Es werden drei Aktionen aufgeführt: Eine Aktion ist mit „Erfolgreich“ markiert, eine mit „Umgehung“ und eine mit „Fehler“ und der Bezeichnung „Auswerten“.

If a ruleset is running in "Evaluate" mode, you can see actions that would have passed or failed if the ruleset had been active.

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.
  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.
  3. In the left sidebar, in the "Policies" section, click Code, then click Rulesets.
  4. On the "Rule insights" page, use the dropdown menus at the top of the page to filter the actions by ruleset, repository, actor, and time period.
  5. To see which specific rules failed or required a bypass, click , then expand the name of the ruleset.

Verwalten von Anforderungen zum Umgehen von Pushregeln

Note

Die delegierte Umgehung für Push-Regeln befindet sich derzeit in der public preview und kann noch geändert werden.

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