Branch-Schutz konfigurieren

Auf dieser Seite wird beschrieben, wie Sie den Branch-Schutz für Secure Source Manager-Repositories konfigurieren.

Mit dem Branch-Schutz können Repository-Administratoren Regeln festlegen, um zu steuern, wer Änderungen an Branches vornehmen kann, wer Änderungen genehmigen oder überprüfen muss und welche Bedingungen erfüllt sein müssen, bevor eine genehmigte Änderung in einen Branch zusammengeführt werden kann.

Weitere Informationen zu Regeln für den Branch-Schutz finden Sie unter Branch protection overview.

Hinweis

  1. Erstellen Sie eine Secure Source Manager-Instanz.
  2. Erstellen Sie ein Secure Source Manager-Repository.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Konfigurieren von Regeln für den Branch-Schutz für ein Secure Source Manager-Repository benötigen:

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Informationen zum Zuweisen von Secure Source Manager-Rollen, siehe Zugriffssteuerung mit IAM und Nutzern Zugriff auf Instanzen gewähren.

Regel für den Branch-Schutz erstellen

Console

So erstellen Sie eine neue Regel für den Branch-Schutz:

  1. Wählen Sie in der Secure Source Manager-Weboberfläche das Repository aus, das Sie mit einer Regel für den Branch-Schutz schützen möchten.
  2. Klicken Sie auf der Repository-Seite auf Einstellungen.
  3. Klicken Sie auf den Tab Branch-Regel.
  4. Klicken Sie auf Branch-Regel hinzufügen.

  5. Geben Sie im Feld Branch-Regel-ID einen Namen für die Branch-Regel ein.

    Branch-Regel-IDs dürfen nur Kleinbuchstaben, Ziffern und Bindestriche enthalten. Das erste Zeichen muss ein Buchstabe und das letzte Zeichen ein Buchstabe oder eine Ziffer sein. Branch-Regel-IDs dürfen maximal 63 Zeichen lang sein.

  6. Geben Sie im Feld Branch-Filter den Namen des Branches ein, auf den die Regel angewendet werden soll. Wenn die Regel auf alle Branches angewendet werden soll, geben Sie .* ein. Die vollständige Übereinstimmung mit regulären Ausdrücken wird nicht unterstützt.

    Aktivierte Branch-Regel-Filter müssen für das jeweilige Repository eindeutig sein. Nutzer können mehrere deaktivierte Branch-Regel-Filter haben. Sie können beispielsweise nicht zwei aktivierte Branch-Regeln in einem einzelnen Repository mit dem Branch-Filter main haben.

    Wenn mehrere Regeln für einen Branch gelten, überschreibt die Branch-Regel mit einem bestimmten Branch-Namen als Branch-Filter die Platzhalterregel. Beispielsweise überschreibt eine Branch-Regel mit dem Branch-Filter main eine Branch-Regel mit dem Branch-Filter .*. Regeln werden nicht kombiniert.

  7. Geben Sie im Abschnitt Details zur Regel für den Branch-Schutz die Anforderungen für Ihre Branch-Regel an. Wählen Sie dazu eine der folgenden Optionen aus:

    • Pull-Anfrage vor dem Zusammenführen erforderlich: Wenn diese Option aktiviert ist, werden direkte Commits an den Branch blockiert. Vor dem Zusammenführen in den geschützten Branch muss eine Pull-Anfrage geöffnet werden.

    • Erforderliche Anzahl von Prüfern: Geben Sie die Anzahl der Prüfer an, die die Pull-Anfrage genehmigen müssen, damit sie zusammengeführt werden kann.

    • Erforderliche Anzahl von Genehmigern: Geben Sie die Anzahl der Genehmiger an, die die Pull-Anfrage genehmigen müssen, damit sie zusammengeführt werden kann.

      Prüfer und Genehmiger sind Nutzer mit bestimmten IAM-Rollen. Informationen zu den erforderlichen Rollen für Prüfer und Genehmiger finden Sie unter Übersicht über den Branch-Schutz.

    • Zusammenführen bei veralteten Überprüfungen und Genehmigungen blockieren: Wenn diese Option aktiviert ist, wird eine Überprüfung oder Genehmigung entfernt, wenn nach der Überprüfung oder Genehmigung neue Commits an die Pull-Anfrage gepusht werden.

    • Konversationsauflösung vor dem Zusammenführen erforderlich: Wenn diese Option aktiviert ist, müssen alle Codekommentare und Überprüfungen von Änderungsanfragen vor dem Zusammenführen aufgelöst werden.

    • Lineare Historie erforderlich: Wenn diese Option aktiviert ist, können Pull-Anfragen, die eine nicht lineare Git-Historie erstellen würden, nicht zusammengeführt werden.

    • Statusprüfungen erforderlich: Wenn diese Option aktiviert ist, müssen die ausgewählten Build-Statusprüfungen erfolgreich sein, bevor eine Pull-Anfrage zusammengeführt werden kann. Sie müssen Trigger in Ihrer Triggerdatei konfigurieren, bevor Sie sie als Statusprüfungen für den Branch-Schutz auswählen können.

  8. Klicken Sie auf Senden, um die Branch-Regel zu speichern.

Der Tab Branch-Regeln wird angezeigt und Ihre neue Branch-Regel ist aufgeführt.

Terraform

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle. Weitere Informationen finden Sie in der Terraform Anbieter-Referenzdokumentation.

Verwenden Sie die google_secure_source_manager_branch_rule Ressource, um eine neue Regel für den Branch-Schutz mit Terraform zu erstellen.

Die folgende Beispielkonfiguration erstellt eine Regel für den Branch-Schutz für den Branch main.

Ersetzen Sie vor der Verwendung des Beispiels Folgendes:

  • BRANCH_RULE_ID: die ID der Regel für den Branch-Schutz.
  • PROJECT_ID: die Projekt-ID.
  • LOCATION: der Standort des Repositorys.
  • REPOSITORY_ID: die ID des Repositorys.
  • BRANCH_NAME_PATTERN: der Branch-Name oder das Muster für reguläre Ausdrücke, z. B. main.
resource "google_secure_source_manager_branch_rule" "default" {
  branch_rule_id = "BRANCH_RULE_ID"
  project = "PROJECT_ID"
  location = "LOCATION"
  repository_id = "REPOSITORY_ID"
  include_pattern = "BRANCH_NAME_PATTERN"
  minimum_approvals_count   = 2
  minimum_reviews_count     = 2
  require_comments_resolved = true
  require_linear_history    = true
  require_pull_request      = true
  disabled = false
  allow_stale_reviews = false
}

Regel für den Branch-Schutz ändern

So ändern Sie eine Regel für den Branch-Schutz:

  1. Wählen Sie in der Secure Source Manager-Weboberfläche das Repository mit der Regel für den Branch-Schutz aus, die Sie ändern möchten.
  2. Klicken Sie auf der Repository-Seite auf Einstellungen.
  3. Klicken Sie auf den Tab Branch-Regeln.
  4. Klicken Sie auf den Namen der Branch-Regel, die Sie ändern möchten.
  5. Bearbeiten Sie die Regel für den Branch-Schutz.
  6. Klicken Sie auf Aktualisieren.

Die Regel für den Branch-Schutz wird aktualisiert.

Regel für den Branch-Schutz löschen

So löschen Sie eine Regel für den Branch-Schutz:

  1. Wählen Sie in der Secure Source Manager-Weboberfläche das Repository aus, aus dem Sie die Branch-Regel entfernen möchten.
  2. Klicken Sie auf der Repository-Seite auf Einstellungen.
  3. Klicken Sie auf den Tab Branch-Regel.
  4. Klicken Sie in der Zeile der Regel, die Sie löschen möchten, auf das Symbol Löschen Löschen.
  5. Klicken Sie im Bestätigungsbildschirm Branch-Regel entfernen auf Ja.

Die Regel für den Branch-Schutz wird gelöscht.

Nächste Schritte