Note
Benutzerdefinierte Regeln für den Bereitstellungsschutz befinden sich derzeit in der beta. Änderungen sind vorbehalten.
Informationen zu benutzerdefinierten Regeln für den Bereitstellungsschutz
Benutzerdefinierte Regeln für den Bereitstellungsschutz werden von GitHub Apps unterstützt. Sobald eine Bereitstellungsschutzregel konfiguriert und in einem Repository installiert ist, kann sie für alle Umgebungen im Repository aktiviert werden.
Nachdem du eine benutzerdefinierte Bereitstellungsschutzregel für eine Umgebung aktiviert hast, wird diese jedes Mal automatisch ausgeführt, wenn diese Umgebung Ziel in einem Workflowschritt ist. Weitere Informationen zum Verwenden einer Umgebung als Ziel für Bereitstellungen findest du unter Verwalten von Umgebungen für die Bereitstellung.
Wenn eine benutzerdefinierte Bereitstellungsschutzregel ausgelöst wird, wartet sie bis zu 30 Tage lang auf eine Webhook-Ereignisantwort, bevor sie eine Zeitüberschreitung verursacht und der Workflowauftrag fehlschlägt.
Weitere Informationen zum Erstellen eigener benutzerdefinierter Bereitstellungsschutzregeln findest du unter Erstellen von benutzerdefinierten Regeln für den Bereitstellungsschutz.
Note
In einem Repository kann eine beliebige Anzahl von auf GitHub Apps basierenden Regeln für den Bereitstellungsschutz installiert werden. Es dürfen jedoch maximal sechs Bereitstellungsschutzregeln gleichzeitig in jeder Umgebung aktiviert sein.
Verwenden vorhandener benutzerdefinierter Regeln für den Bereitstellungsschutz
Du kannst eigene benutzerdefinierte Bereitstellungsschutzregeln erstellen oder alle vorhandenen benutzerdefinierten Bereitstellungsschutzregeln verwenden.
Im Folgenden findest du eine Liste der offiziellen Partnerimplementierungen für Bereitstellungsschutzregeln.
- Datadog: Du kannst Schutzregeln für deine GitHub Actions-Bereitstellungsworkflows mithilfe von Datadog-Monitoren erzwingen. Weitere Informationen findest du unter Gating your GitHub Actions Deployments with Datadog Monitors in der Datadog-Dokumentation.
- Honeycomb: Du kannst Schwellenwerte definieren, um Bereitstellungen basierend auf Daten, die du an Honeycomb sendest, abzulehnen oder zu genehmigen. Weitere Informationen findest du bei der Honeycomb-App im GitHub Marketplace.
- New Relic: Weitere Informationen findest du bei der New Relic-App im GitHub Marketplace.
- NCM NodeSource: Weitere Informationen findest du bei der NCM NodeSource-App im GitHub Marketplace.
- Sentry: Weitere Informationen findest du bei der Sentry Deployment Gate-App im GitHub Marketplace.
- ServiceNow: Weitere Informationen findest du unter DevOps in der ServiceNow-Dokumentation.
Voraussetzungen
Damit eine benutzerdefinierte Regel für den Bereitstellungsschutz für alle Umgebungen in einem Repository verfügbar ist, musst du die Regel zuerst im Repository installieren. Weitere Informationen finden Sie unter Installieren einer eigenen GitHub-App.
Nachdem eine benutzerdefinierte Regel für den Bereitstellungsschutz in einem Repository installiert wurde, muss sie für alle Umgebungen aktiviert werden, in denen sie gelten soll.
Aktivieren von benutzerdefinierten Bereitstellungsschutzregeln für die Umgebung
-
Navigieren Sie auf GitHub zur Hauptseite des Repositorys.
-
Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.
-
Klicke auf der linken Randleiste auf Umgebungen.
-
Wähle die Umgebung aus, die du konfigurieren möchtest.
-
Aktiviere unter „Regeln für den Bereitstellungsschutz“ das Kontrollkästchen neben jeder benutzerdefinierten Bereitstellungsschutzregel, die du für die Umgebung aktivieren möchtest.
-
Klicke auf Schutzregeln speichern.
Sobald eine benutzerdefinierte Bereitstellungsschutzregel für eine Umgebung aktiviert wurde, wird sie automatisch ausgeführt, wenn ein Workflow einen Auftrag erreicht, der auf die Umgebung verweist. Du kannst die Ergebnisse einer Genehmigung oder Ablehnung für deine Bereitstellung in den Details der Bereitstellung anzeigen. Weitere Informationen finden Sie unter Überprüfen von Bereitstellungen.