Verwalten von Umgebungen für die Bereitstellung

Sie können Umgebungen erstellen und diese Umgebungen mit Regeln für den Bereitstellungsschutz schützen. Ein Auftrag, der auf eine Umgebung verweist, muss alle Schutzregeln für diese Umgebung befolgen, ehe er ausgeführt wird oder auf die Geheimnisse der Umgebung zugreift.

Wer kann dieses Feature verwenden?

Repository owners

Environments, environment secrets, and deployment protection rules are available in public repositories for all current GitHub plans. They are not available on legacy plans, such as Bronze, Silver, or Gold. For access to environments, environment secrets, and deployment branches in private or internal repositories, you must use GitHub Pro, GitHub Team, or GitHub Enterprise.

In diesem Artikel

Voraussetzungen

Erstellen einer Umgebung

Um eine Umgebung in einem Repository eines persönlichen Kontos zu konfigurieren, musst du der Repositorybesitzer sein. Um eine Umgebung in einem Organisationsrepository zu konfigurieren, musst du admin-Zugriff haben.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

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

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste auf Umgebungen.

  4. Klicke auf Neue Umgebung.

  5. Gib einen Namen für die Umgebung ein, und klicke dann auf Umgebung konfigurieren. Bei Umgebungsnamen wird nicht zwischen Groß- und Kleinschreibung unterschieden. Ein Umgebungsname darf 255 Zeichen nicht überschreiten und muss innerhalb des Repositorys eindeutig sein.

  6. Du kannst optional Personen oder Teams angeben, die Workflowaufträge mit Verwendung dieser Umgebung genehmigen müssen. Weitere Informationen finden Sie unter Bereitstellungen und Umgebungen.

    1. Wähle Required reviewers aus.
    2. Gib bis zu 6 Personen oder Teams ein. Nur einer der erforderlichen Reviewer muss den Auftrag genehmigen, damit er fortgesetzt werden kann.
    3. Um zu verhindern, dass Benutzende von dir ausgelöste Workflowausführungen genehmigen, kann optional Selbstüberprüfung verhindern ausgewählt werden.
    4. Klicke auf Schutzregeln speichern.

  7. Gib optional die Zeitspanne an, die gewartet werden soll, bevor Workflowaufträge mit Verwendung dieser Umgebung fortgesetzt werden können. Weitere Informationen finden Sie unter Bereitstellungen und Umgebungen.

    1. Wähle Wartetimer aus.
    2. Gib die gewünschte Wartezeit in Minuten ein.
    3. Klicke auf Schutzregeln speichern.

  8. Optional kannst du die festlegen, dass die Umgehung konfigurierter Schutzregeln nicht zugelassen wird. Weitere Informationen finden Sie unter Bereitstellungen und Umgebungen.

    1. Deaktiviere Administratoren erlauben, konfigurierte Schutzregeln zu umgehen.
    2. Klicke auf Schutzregeln speichern.

  9. Optional kannst du alle benutzerdefinierten Regeln für den Bereitstellungsschutz aktivieren, die mit GitHub Apps erstellt wurden. Weitere Informationen finden Sie unter Bereitstellungen und Umgebungen.

    1. Wähle die benutzerdefinierte Schutzregel aus, die du aktivieren möchtest.
    2. Klicke auf Schutzregeln speichern.

  10. Optional kannst du angeben, welche Branches und Tags Bereitstellungen in dieser Umgebung durchführen können. Weitere Informationen finden Sie unter Bereitstellungen und Umgebungen.

    1. Wähle die gewünschte Option im Dropdownmenü Bereitstellungsbranches aus.

    2. Wenn du Selected branches and tags ausgewählt hast, klicke auf Add deployment branch or tag rule, um eine neue Regel hinzuzufügen.

    3. Klicke abhängig von der anzuwendenden Regel im Dropdownmenü „Ref type“ auf Branch oder Tag.

    4. Gib das Namensmuster für den Branch oder das Tag ein, den bzw. das du zulassen möchtest.

      Hinweis

      Namensmuster müssen einzeln für Branches oder Tags konfiguriert werden.

    5. Klicken Sie auf Regel hinzufügen.

  11. Optional kannst du Umgebungsgeheimnisse hinzufügen. Diese Geheimnisse sind nur für Workflowaufträge verfügbar, die die Umgebung verwenden. Außerdem können Workflowaufträge mit Verwendung dieser Umgebung erst dann auf diese Geheimnisse zugreifen, wenn alle konfigurierten Regeln (z. B. erforderliche Reviewer) erfüllt sind. Weitere Informationen finden Sie unter Bereitstellungen und Umgebungen.

    1. Klicke unter Umgebungsgeheimnisse auf Geheimnis hinzufügen.
    2. Gib den Geheimnisnamen ein.
    3. Gib den Geheimniswert ein.
    4. Klicke auf Geheimnis hinzufügen.

  12. Optional kannst du Umgebungsvariablen hinzufügen. Diese Variablen stehen nur für Workflowaufträge zur Verfügung, die die Umgebung verwenden, und sind nur über den vars-Kontext zugänglich. Weitere Informationen finden Sie unter Bereitstellungen und Umgebungen.

    1. Klicke unter Umgebungsvariablen auf Variable hinzufügen.
    2. Gib den Namen der Variablen ein.
    3. Gib den Wert der Variablen ein.
    4. Klicke auf Variable hinzufügen.

Du kannst auch Umgebungen über die REST-API erstellen und konfigurieren. Weitere Informationen findest du unter REST-API-Endpunkte für Bereitstellungsumgebungen, REST-API-Endpunkte für GitHub-Actions-Geheimnisse, REST-API-Endpunkte für GitHub-Actions-Variablen und REST-API-Endpunkte für Richtlinien für Bereitstellungsbranches.

Wenn du einen Workflow ausführst, der auf eine nicht vorhandene Umgebung verweist, wird eine Umgebung mit dem referenzierten Namen erstellt. Wenn die Umgebung aus der Ausführung impliziter Seitenbuilds (z. B. aus einer Verzweigung oder einer Ordnerquelle) erstellt wird, wird die Quellverzweigung als Schutzregel zur Umgebung hinzugefügt. Andernfalls werden für die neu erstellte Umgebung keine Schutzregeln oder Geheimnisse konfiguriert. Jeder Benutzer, der Workflows im Repository bearbeiten kann, kann Umgebungen über eine Workflowdatei erstellen, aber nur Repositoryadministratoren können die Umgebung konfigurieren.

Löschen einer Umgebung

Um eine Umgebung in einem Repository eines persönlichen Kontos zu konfigurieren, musst du der Repositorybesitzer sein. Um eine Umgebung in einem Organisationsrepository zu konfigurieren, musst du admin-Zugriff haben.

Wenn du eine Umgebung löschst, werden alle Geheimnisse und Schutzregeln gelöscht, die dieser Umgebung zugeordnet sind. Alle Aufträge, die aufgrund von Schutzregeln aus der gelöschten Umgebung warten, schlagen automatisch fehl.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

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

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste auf Umgebungen.

  4. Klicke neben der Umgebung, die du löschen möchtest, auf .

  5. Klicke auf Verstanden, diese Umgebung löschen.

Du kannst Umgebungen auch über die REST-API löschen. Weitere Informationen finden Sie unter REST-API-Endpunkte für Repositorys.

Beziehung zwischen Umgebungen und Bereitstellungen

Wenn ein Workflowauftrag, der auf eine Umgebung verweist, erstellt er ein Bereitstellungsobjekt mit der Eigenschaft environment, die auf den Namen Deiner Umgebung festgelegt ist. Im Verlauf des Workflows werden außerdem Bereitstellungsstatusobjekte erstellt, deren Eigenschaft environment auf den Namen Deiner Umgebung, deren Eigenschaft environment_url auf die URL der Umgebung (falls im Workflow angegeben) und deren Eigenschaft state auf den Status des Auftrags gesetzt ist.

Du kannst auf diese Objekte über die REST-API oder die GraphQL-API zugreifen. Du kannst diese Webhookereignisse auch abonnieren. Weitere Informationen findest du unter REST-API-Endpunkte für Repositorys, Objects (GraphQL-API) oder Webhook-Ereignisse und -Nutzlasten.

Nächste Schritte

GitHub Actions bietet verschiedene Funktionen zum Verwalten deiner Bereitstellungen. Weitere Informationen finden Sie unter Bereitstellen mit GitHub Actions.