Angeben empfohlener Geheimnisse für ein Repository

Sie können der Konfiguration des Entwicklungscontainers eine Einstellung hinzufügen, die Personen beim Erstellen eines Codespaces auffordert, bestimmte Entwicklungsumgebungs-Geheimnisse festzulegen.

Wer kann dieses Feature verwenden?

People with write permissions to a repository can create or edit the codespace configuration.

In diesem Artikel

Wenn für ein Projekt benutzerspezifische Geheimnisse eingerichtet werden müssen, kannst du Benutzer*innen bei der Erstellung eines Codespaces dazu auffordern. Füge hierzu der Konfigurationsdatei des Entwicklungscontainers für das Repository eine Einstellung hinzu.

Wenn du empfohlene Geheimnisse angegeben hast, werden Benutzerinnen, die noch keine Geheimnisse in ihren persönlichen Einstellungen für Codespaces erstellt haben, genau dazu aufgefordert, wenn sie zum Erstellen eines Codespaces die erweiterten Optionen verwenden. Dies erfolgt auf GitHub, wenn Benutzerinnen auf die Schaltfläche Code klicken, dann auf die Registerkarte Codespaces und auf und anschließend auf Neu mit Optionen.

Screenshot: Dropdownmenü „Optionen“ auf der Registerkarte „Codespaces“ mit der hervorgehobenen Option „Neu mit Optionen“

Am Ende der Seite werden empfohlene Geheimnisse aufgeführt.

Screenshot of the "Create codespace" page with four recommended secrets highlighted with a dark orange outline.

Note

Die Namen der empfohlenen Geheimnisse werden nur auf dieser Seite aufgeführt, wenn die Containerkonfiguration des ausgewählten Branchs diese Geheimnisse angibt.

Jedes empfohlene Geheimnis wird auf eine von drei Arten angezeigt:

  • Benutzer*innen, die das empfohlene Geheimnis noch nicht in ihren persönlichen Codespaces-Einstellungen festgelegt haben, wird ein Eingabefeld angezeigt, in dem sie das Geheimnis direkt erstellen können. Du kannst eine Beschreibung und einen Link zu weiteren Informationen konfigurieren, die hier angezeigt werden. Die Eingabe eines Werts ist optional.
  • Benutzer*innen, die das empfohlene Geheimnis bereits erstellt, aber noch nicht diesem Repository zugeordnet haben, können ein Kontrollkästchen aktivieren, um diese Zuordnung hinzuzufügen. Dies ist optional.
  • Benutzer*innen, die das empfohlene Geheimnis bereits erstellt und diesem Repository zugeordnet haben, wird ein vorab aktiviertes Kontrollkästchen angezeigt.

Empfohlene Geheimnisse sollten für Entwicklungsumgebungs-Geheimnisse verwendet werden, die Benutzerinnen bereitstellen müssen, die einen Codespace erstellen, und nicht die Besitzerinnen des Repositorys oder der Organisation. Bei einem öffentlichen Projekt, für das Benutzerinnen z. B. einen persönlichen API-Schlüssel benötigen, um die Anwendung in deinem Projekt auszuführen, kannst du mithilfe eines empfohlenen Geheimnisses Benutzerinnen dazu auffordern, den Schlüssel als Geheimniswert anzugeben, wenn sie über die Seite „Erweiterte Optionen“ einen Codespace erstellen.

Alternativ können Sie für Entwicklungsumgebungs-Geheimnisse, die der/die Besitzer*in des Repositorys oder der Organisation bereitstellen kann, wie z. B. API-Schlüssel, die von einem Team gemeinsam genutzt werden, Geheimnisse auf der Ebene des Repositorys oder der Organisation festlegen. Weitere Informationen finden Sie unter Verwalten von Entwicklungsumgebungs-Geheimnissen für Ihr Repository oder Ihre Organisation.

  1. Füge einer devcontainer.json-Datei Einstellungen hinzu, um die für dein Repository erstellten Codespaces zu konfigurieren. Wenn dein Repository noch keine devcontainer.json-Datei enthält, kannst du jetzt eine hinzufügen. Weitere Informationen findest du unter Hinzufügen einer Entwicklungscontainerkonfiguration zu deinem Repository.

  2. Bearbeite die Datei devcontainer.json, und füge die Eigenschaft secrets innerhalb des umschließenden JSON-Objekts am Anfang der Datei hinzu. Beispiel:

    JSON
    "secrets": {
  "NAME_OF_SECRET_1": {
    "description": "This is the description of the secret.",
    "documentationUrl": "https://example.com/link/to/info"
  },
  "NAME_OF_SECRET_2": { }
}

  3. Füge in secrets für jedes Geheimnis, das du empfehlen möchtest, eine Eigenschaft hinzu. Ändere im vorherigen Codebeispiel etwa NAME_OF_SECRET_1 und NAME_OF_SECRET_2 in die Namen der Geheimnisse, die Benutzer*innen in ihren persönlichen Einstellungen für Codespaces erstellen sollen.

  4. Wahlweise kannst du eine Beschreibung und eine URL mit weiteren Informationen zu jedem Geheimnis bereitstellen.

    Wie bei NAME_OF_SECRET_2 im vorherigen Codebeispiel gezeigt, kannst du description und documentationUrl weglassen.

  5. Gib nach Bedarf weitere Geheimnisse an.

  6. Speichere die Datei, und committe deine Änderungen in den gewünschten Branch des Repositorys.

Weiterführende Themen