Erzwingen der Codegovernance in deinem Unternehmen mit Regelsätzen

Einführung

Du kannst Regelsätze erstellen, um zu steuern, wie Benutzende mit Code in Repositorys in deinem Unternehmen interagieren können. Sie können Folgendes ausführen:

• Erstelle einen Branch- oder Tagregelsatz, um Vorgänge zu steuern, z. B. wer Commits an einen bestimmten Branch pushen kann, wie Commits formatiert werden müssen oder wer ein Tag löschen oder umbenennen kann.
• Erstelle einen Push-Regelsatz, um Pushes an ein privates oder internes Repository und das gesamte Forknetzwerk des Repositorys zu blockieren. Mithilfe von Push-Regelsätzen können Sie Pushes basierend auf Dateierweiterungen, Dateipfadlängen, Datei- und Ordnerpfaden und Dateigrößen blockieren.

Weitere Informationen findest du unter Informationen zu Regelsätzen.

Importieren vordefinierter Regelsätze

Informationen zum Importieren eines vordefinierten Regelsatzes, der von GitHub erstellt wurde, findest du unter github/ruleset-recipes.

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. Weitere Informationen findest du unter Verwalten von Regelsätzen für Repositorys in deiner Organisation.

Wie definiere ich, wo mein Regelsatz gilt?

Mit Regelsätzen kannst du flexibel auf die Organisationen, Repositorys und Branches abzielen, für die Regeln angewendet werden sollen.

• Um auf Organisationen abzuzielen, kannst du alle auswählen, sie aus einer Liste auswählen oder ein dynamisches Muster für Organisationsnamen mithilfe der Syntax fnmatch definieren. Details zur Syntax findest du unter Erstellen von Regelsätzen für ein Repository.
• In diesen Organisationen kannst du alle Repositorys als Ziel verwenden oder eine dynamische Liste nach benutzerdefinierter Eigenschaft als Ziel festlegen. Weitere Informationen findest du unter Verwalten von benutzerdefinierten Eigenschaften für Repositorys in Ihrer Organisation.
• Innerhalb der Repositorys kannst du bestimmte Branches oder Tags als Ziel festlegen: alle Branches, die Standardbranches oder eine dynamische Liste mit der fnmatch-Syntax.

Wenn du einen Regelsatz erstellst, das auf Branches in einem Repository abzielt, können Repositoryadministratoren keine Branches mehr umbenennen oder den Standardbranch im zielbezogenen Repository ändern. Sie können weiterhin Branches erstellen und löschen, wenn sie über die entsprechenden Berechtigungen verfügen.

Wie kann ich das Format von Commits steuern?

In Branch- oder Tagregelsätzen kannst du eine Regel hinzufügen, die das Format von Commitmetadaten wie eine Commitnachricht oder E-Mail-Adresse des Commiterstellenden einschränkt.

Wenn du die Option Muss mit einem bestimmten regex-Muster übereinstimmen auswählst, kannst du die Syntax eines regulären Ausdrucks verwenden, um Muster zu definieren, mit der die Metadaten übereinstimmen müssen oder nicht dürfen. Ausführliche Informationen zu Syntax und Beispielen findest du unter Erstellen von Regelsätzen für ein Repository.

Verwenden von Regelsatz-Erzwingungsstatus

Beim Erstellen oder Bearbeiten Ihres Regelsatzes können Sie Erzwingungsstatus verwenden, um zu konfigurieren, wie Ihr Regelsatz erzwungen wird.

Sie können einen der folgenden Erzwingungsstatus für Ihr Regelsatz auswählen.

• Active: Dein Regelsatz wird beim Erstellen erzwungen.
• Evaluate: Dein Regelsatz wird nicht erzwungen, doch du kannst überwachen auf der Seite „Rule Insights“ überwachen, welche Aktionen die Regeln verletzen würden.
• Disabled: Dein Regelsatz wird nicht erzwungen oder ausgewertet.

Die Verwendung des Modus „Auswerten“ ist eine hervorragende Option zum Testen des Regelsets, ohne es zu erzwingen. Sie können die Seite „Regeleinblicke“ verwenden, um festzustellen, ob der Beitrag gegen die Regel verstoßen hätte. Weitere Informationen finden Sie unter Verwalten von Regelsätzen für ein Repository.

Erstellen eines Verzweigungs- oder Tagregelsatzes

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. Klicken Sie auf der linken Seite der Seite in der Randleiste des Enterprise-Kontos auf Richtlinien

4. Klicke unter „Richtlinien“ auf Code.

5. Klicken Sie auf Neuer Regelsatz.

6. Klicke auf Neuer Regelsatz für Branches, um einen Regelsatz für Branches zu erstellen. Wenn Sie ein Regelsatz für Tags erstellen möchten, klicken Sie auf Neues Tag-Regelsatz.

7. Geben Sie unter „Regelsatzname“ einen Namen für den Regelsatz ein.

8. Um den standardmäßigen Durchsetzungsstatus zu ändern, klicken Sie auf Deaktiviert und wählen Sie einen Durchsetzungsstatus aus. Weitere Informationen zu Erzwingungsstatus findest du unter Informationen zu Regelsätzen.

Gewähren von Umgehungsberechtigungen für Ihre Verzweigungs- oder Ihren Tag-Regelsatz

Du kannst bestimmten Rollen, Teams oder Apps Berechtigungen zur Umgehung gewähren sowie die Möglichkeit, Umgehungsanforderungen für deinen Regelsatz zu genehmigen.

Für folgende Elemente kann Umgehungszugriff eingerichtet werden:

• Repositoryadministratoren, Organisationsbesitzer und Unternehmensbesitzer
• Die Rolle „Beibehalten“ oder „Schreiben“ oder Schlüssel zum Bereitstellen

1. Klicke im Abschnitt „Umgehungsliste“ auf Umgehung hinzufügen, um Umgehungsberechtigungen für den Regelsatz hinzuzufügen.

2. Suchen Sie im angezeigten modalen Dialogfeld „Umgehung hinzufügen“ nach der Rolle, dem Team oder der Anwendung, für die Sie Umgehungsberechtigungen erteilen möchten, wählen Sie dann die Rolle, das Team oder die Anwendung aus dem Abschnitt „Vorschläge“ aus und klicken Sie auf Ausgewählte hinzufügen.

3. Optional klicken Sie rechts von „Immer Zulassen“ auf und dann auf Nur für Pull-Requests, um eine Überbrückung an einen Akteur zu gewähren, ohne sie direkt an ein Repository zu übertragen.

   Der ausgewählte Akteur ist jetzt aufgefordert, eine Pull-Anforderung zu öffnen, um Änderungen an einem Repository vorzunehmen und eine klare Spur ihrer Änderungen im Pull Request und Überwachungsprotokoll zu erstellen. Die Akteur*innen können dann alle Schutzmechanismen für den Branch umgehen und diesen Pull Request mergen.

Auswählen, welche Organisationen in deinem Unternehmen als Ziel verwendet werden sollen

Wähle alle Organisationen aus, wähle einige vorhandene Organisationen aus, oder lege anhand des Namens eine dynamische Liste fest. Wenn du Enterprise Managed Users verwendest, kannst du auch alle Repositorys auswählen, die sich im Besitz von Benutzern deines Unternehmens befinden.

Wenn du eine dynamische Liste festlegst, fügst du mithilfe der fnmatch-Syntax ein oder mehrere Benennungsmuster hinzu. Beispielsweise würde die Zeichenfolge *open-source mit allen Organisationen übereinstimmen, deren Namen mit open-source enden. Weitere Informationen zur Syntax findest du unter Erstellen von Regelsätzen für ein Repository.

Auswählen der Repositorys, die in deinem Unternehmen als Ziel verwendet werden sollen

In den ausgewählten Organisationen kannst du alle Repositorys als Ziel verwenden oder eine dynamische Liste nach benutzerdefinierter Eigenschaft als Ziel festlegen. Weitere Informationen findest du unter Verwalten von benutzerdefinierten Eigenschaften für Repositorys in Ihrer Organisation.

Auswählen, welche Verzweigungen oder Tags als Ziel dienen sollen

Wählen Sie im Abschnitt „Ziel-Verzweigungen“ oder „Ziel-Tags“ die Option Ziel hinzufügen aus, und legen Sie dann fest, wie Sie Verzweigungen oder Tags ein- oder ausschließen möchten. Mithilfe der fnmatch-Syntax kannst du Branches oder Tags basierend auf einem Muster ein- oder ausschließen. Weitere Informationen findest du unter Verwenden der fnmatch-Syntax.

Du kannst demselben Regelsatz mehrere Ausrichtungskriterien hinzufügen. Du kannst beispielsweise den Standardbranch und alle Branches einschließen, die dem Muster *feature* entsprechen, und dann explizit einen Branch ausschließen, der dem Muster not-a-feature entspricht.

Auswählen von Verzweigungs- oder Tagschutz

Wähle im Abschnitt „Schutz von Branches“ oder „Schutz von Tags“ die Regeln aus, die im Regelsatz enthalten sein sollen. Wenn du eine Regel auswählst, kannst du möglicherweise weitere Einstellungen für die Regel eingeben. Weitere Informationen zu den Regeln findest du unter Verfügbare Regeln für Regelsätze.

Metadateneinschränkungen hinzufügen

Deine Metadateneinschränkungen sollen die Konsistenz zwischen Commits in deinem Repository erhöhen. Sie sind nicht dazu bestimmt, Sicherheitsmaßnahmen wie die Anforderung eines Code Reviews über Pull Requests zu ersetzen.

1. Um eine Regel zum Steuern von Commit-Metadaten oder Branchnamen hinzuzufügen, klicke beim Erstellen oder Bearbeiten eines Regelsatzes im Abschnitt „Restrictions“ auf Restrict commit metadata oder auf Restrict branch names.

2. Konfigurieren Sie die Einstellungen für die Einschränkung und klicken Sie dann auf Hinzufügen. Dem gleichen Regelsatz können mehrere Einschränkungen hinzugefügt werden.

3. Um einem bestimmten regex-Muster zu entsprechen, wählen Sie im Dropdownmenü „Anforderung“ die Option Muss einem bestimmten regex-Muster entsprechen aus.

   Für die meisten Anforderungen, z. B. „Muss mit einem übereinstimmenden Muster beginnen“, wird das von dir eingegebene Muster wörtlich interpretiert, und Platzhalter werden nicht unterstützt. Das Zeichen * stellt beispielsweise nur das Literalzeichen * dar.

   Für komplexere Muster kannst du „Muss einem bestimmten Regex-Muster entsprechen“ oder „Darf nicht mit einem bestimmten Regex-Muster übereinstimmen“ auswählen. Verwende dann die Syntax regulärer Ausdrücke, um das übereinstimmende Muster zu definieren. Weitere Informationen findest du unter Über reguläre Ausdrücke für Commit-Metadaten.

   Alle, die die Regelsätze für ein Repository anzeigen, können die von dir bereitgestellte Beschreibung sehen.

4. Bevor du deinen Regelsatz mit Metadateneinschränkungen aktivierst, kannst du optional den Erzwingungsstatus „Evaluate“ für deinen Regelsatz auswählen, um die Auswirkungen von Metadateneinschränkungen zu testen, ohne Mitwirkende zu beeinträchtigen. Weitere Informationen zu Metadateneinschränkungen findest du unter Verfügbare Regeln für Regelsätze.

Abschließen des Verzweigungs- oder Tag-Regelsatzes und der nächsten Schritte

Klicken Sie auf Erstellen, um das Erstellen des Regelsets zu beenden. Wenn der Durchsetzungsstatus des Regelsatzes auf „Aktiv“ eingestellt ist, wird der Regelsatz sofort wirksam.

Sie können Erkenntnisse für den Regelsatz anzeigen, um zu sehen, wie sich die Regeln auf Ihre Teilnehmer auswirken. Wenn der Durchsetzungsstatus auf „Auswerten“ festgelegt ist, können Sie sehen, welche Aktionen bestanden oder fehlgeschlagen wären, wenn der Regelsatz aktiv war. Weitere Informationen zu den Erkenntnissen für Regelsätze findest du unter Verwalten von Regelsätzen für ein Repository.

Erstellen eines Push-Regelsatzes

Du kannst einen Pushregelsatz für private oder interne Repositorys in deinem Unternehmen erstellen.

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. Klicke in der linken Randleiste im Abschnitt „Richtlinien“ auf Code.
4. Klicken Sie auf Neuer Regelsatz.
5. Klicke auf Neuer Pushregelsatz.
6. Geben Sie unter „Regelsatzname“ einen Namen für den Regelsatz ein.
7. Um den Standardstatus für die Erzwingung zu ändern, klicke auf Deaktiviert, und wähle einen Erzwingungsstatus aus. Weitere Informationen zu Erzwingungsstatus findest du unter Informationen zu Regelsätzen.

Gewähren von Umgehungsberechtigungen für Ihren Push-Regelsatz

Du kannst bestimmten Rollen, Teams oder Apps Berechtigungen zur Umgehung gewähren sowie die Möglichkeit, Umgehungsanforderungen für deinen Regelsatz zu genehmigen. Für folgende Elemente kann Umgehungszugriff eingerichtet werden:

• Repositoryadministratoren, Organisationsbesitzer und Unternehmensbesitzer
• Die Rolle „Beibehalten“ oder „Schreiben“ oder Schlüssel zum Bereitstellen

1. Klicke im Abschnitt „Umgehungsliste“ auf Umgehung hinzufügen, um Umgehungsberechtigungen für den Regelsatz hinzuzufügen.
2. Suchen Sie im angezeigten modalen Dialogfeld „Umgehung hinzufügen“ nach der Rolle, dem Team oder der Anwendung, für die Sie Umgehungsberechtigungen erteilen möchten, wählen Sie dann die Rolle, das Team oder die Anwendung aus dem Abschnitt „Vorschläge“ aus und klicken Sie auf Ausgewählte hinzufügen.

Auswählen, welche Organisationen in deinem Unternehmen als Ziel verwendet werden sollen

Wähle alle Organisationen aus, wähle einige vorhandene Organisationen aus, oder lege anhand des Namens eine dynamische Liste fest. Wenn du Enterprise Managed Users verwendest, kannst du auch alle Repositorys auswählen, die sich im Besitz von Benutzern deines Unternehmens befinden.

Wenn du eine dynamische Liste festlegst, fügst du mithilfe der fnmatch-Syntax ein oder mehrere Benennungsmuster hinzu. Beispielsweise würde die Zeichenfolge *open-source mit allen Organisationen übereinstimmen, deren Namen mit open-source enden. Weitere Informationen zur Syntax findest du unter Erstellen von Regelsätzen für ein Repository.

Auswählen der Repositorys, die in deinem Unternehmen als Ziel verwendet werden sollen

Innerhalb deiner ausgewählten Organisationen kannst du alle Repositorys oder eine dynamische Liste mit benutzerdefinierten Eigenschaften als Ziel festlegen. Weitere Informationen findest du unter Verwalten von benutzerdefinierten Eigenschaften für Repositorys in Ihrer Organisation.

Auswählen von Pushschutz

Sie können Pushes an dieses Repository und das gesamte Forknetzwerk dieses Repositorys basierend auf Dateierweiterungen, Dateipfadlängen, Datei- und Ordnerpfaden und Dateigrößen blockieren.

Jeder von Ihnen konfigurierten Pushschutz blockiert Pushes in diesem Repository und im gesamten Forknetzwerk dieses Repositorys.

1. Klicken Sie unter „Pushschutz“ auf die Einschränkungen, die Sie anwenden möchten. Geben Sie dann die Details für die von Ihnen ausgewählten Einschränkungen ein.

   Für Dateipfadeinschränkungen können Sie teilweise oder vollständige Pfade verwenden. Sie können fnmatch-Syntax hierfür verwenden. Eine Einschränkung, die zum Beispiel auf test/demo/**/* zielt, verhindert Pushes an Dateien oder Ordner im test/demo/-Verzeichnis. Eine Einschränkung mit Ziel test/docs/pushrules.md verhindert Pushs, speziell an die pushrules.md-Datei im test/docs/-Verzeichnis. Weitere Informationen finden Sie unter Erstellen von Regelsätzen für ein Repository.

Abschließen des Push-Regelsatzes und der nächsten Schritte

Klicken Sie auf Erstellen, um das Erstellen des Regelsets zu beenden. Wenn der Durchsetzungsstatus des Regelsatzes auf „Aktiv“ eingestellt ist, wird der Regelsatz sofort wirksam.

Sie können Erkenntnisse für den Regelsatz anzeigen, um zu sehen, wie sich die Regeln auf Ihre Teilnehmer auswirken. Wenn der Durchsetzungsstatus auf „Auswerten“ festgelegt ist, können Sie sehen, welche Aktionen bestanden oder fehlgeschlagen wären, wenn der Regelsatz aktiv war. Weitere Informationen zu den Erkenntnissen für Regelsätze findest du unter Verwalten von Regelsätzen für ein Repository.