Verwalten deiner kontospezifischen Geheimnisse für GitHub Codespaces

Informationen zum Verwalten von Geheimnissen für GitHub Codespaces

Du kannst deinem persönlichen Konto Geheimnisse zur Entwicklungsumgebung hinzufügen, die du in deinen Codespaces verwenden möchten. Sie können beispielsweise die folgenden vertraulichen Informationen als Geheimnisse speichern und darauf zugreifen:

Zugriffstoken für Clouddienste
Dienstprinzipale
Abonnementbezeichner
Anmeldeinformationen für eine private Imageregistrierung (Weitere Informationen findest du unter Zulassen des Codespacezugriffs auf eine private Registrierung.)

Du kannst auswählen, welche Repositorys Zugriff auf das jeweilige Geheimnis haben sollen. Dann kannst du das Geheimnis in jedem Codespace verwenden, den du für ein Repository erstellst, das Zugriff auf dieses Geheimnis hat. Um ein Geheimnis für einen Codespace freizugeben, der mithilfe einer Vorlage erstellt wurde, musst du den Codespace in einem Repository auf GitHub veröffentlichen und dem Repository dann Zugriff auf das Geheimnis gewähren.

Nachdem du ein Geheimnis erstellt hast, ist es verfügbar, wenn du einen neuen Codespace erstellst oder den Codespace neu startest. Wenn Sie auf GitHub ein Geheimnis erstellt haben, das Sie in einem derzeit ausgeführten Codespace ausführen möchten, müssen Sie den Codespace beenden und neu starten. Informationen zum Beenden des Codespace findest du unter Verwenden der Visual Studio Code-Befehlspalette in GitHub Codespaces.

Benennen von Geheimnissen

Für Geheimnisnamen gelten folgende Regeln:

Geheimnisnamen dürfen nur alphanumerische Zeichen ([a-z], [A-Z], [0-9]) oder Unterstriche (_) enthalten. Leerzeichen sind nicht zulässig.
Geheimnisnamen dürfen nicht mit dem Präfix GITHUB_ beginnen.
Geheimnisnamen dürfen nicht mit einer Ziffer beginnen.
Bei Geheimnisnamen wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Geheimnisnamen müssen auf der Ebene eindeutig sein, auf der sie erstellt werden. Ein auf Repositoryebene erstelltes Geheimnis muss beispielsweise einen in diesem Repository eindeutigen Namen haben.

Wenn ein Geheimnis mit demselben Namen auf mehreren Ebenen vorhanden ist, erhält das Geheimnis auf der niedrigsten Ebene Vorrang. Wenn beispielsweise ein Geheimnis auf Organisationsebene denselben Namen wie ein Geheimnis auf Repositoryebene aufweist, erhält das Geheimnis auf Repositoryebene Vorrang.

Einschränkungen für Geheimnisse

Du kannst bis zu 100 Geheimnisse für GitHub Codespaces speichern.

Geheimnisse sind auf 48 KB beschränkt.

Hinzufügen eines Geheimnisses

Klicken Sie auf einer beliebigen Seite auf GitHub oben rechts auf Ihr Profilfoto und dann auf Einstellungen.
Klicke im Abschnitt „Code, Planung und Automatisierung“ der Seitenleiste auf Codespaces.
Klicke rechts neben „Codespacegeheimnisse“ auf Neues Geheimnis.
Gib unter „Name“ einen Namen für das Geheimnis ein.
Gib unter „Wert“ den Wert deines Geheimnisses ein.
Wähle das Dropdownmenü „Repositoryzugriff“ aus, und klicke dann auf ein Repository, in dem du Zugriff auf das Geheimnis haben möchtest. Wiederhole dies für jedes Repository, in dem du Zugriff auf das Geheimnis haben möchtest.
Klicke auf Geheimnis hinzufügen.

Bearbeiten eines Geheimnisses

Du kannst den Wert eines vorhandenen Geheimnisse aktualisieren und ändern, welche Repositorys auf ein Geheimnis zugreifen können.

Klicken Sie auf einer beliebigen Seite auf GitHub oben rechts auf Ihr Profilfoto und dann auf Einstellungen.
Klicke im Abschnitt „Code, Planung und Automatisierung“ der Seitenleiste auf Codespaces.
Klicke unter „Codespace-Geheimnisse“ rechts neben dem Geheimnis, das du bearbeiten möchtest, auf Aktualisieren.
Klicke unter „Wert“ auf den Link „Neuen Wert eingeben“.
Gib unter „Wert“ den Wert deines Geheimnisses ein.
Wähle das Dropdownmenü „Repositoryzugriff“ aus, und klicke dann auf ein Repository, in dem du Zugriff auf das Geheimnis haben möchtest. Wiederhole dies für jedes Repository, in dem du Zugriff auf das Geheimnis haben möchtest.
Optional kannst du auch optional den Zugriff des Geheimnisses auf ein Repository entfernen, indem du das Repository deaktivierst.
Klicke auf Änderungen speichern.

Löschen eines Geheimnisses

Klicken Sie auf einer beliebigen Seite auf GitHub oben rechts auf Ihr Profilfoto und dann auf Einstellungen.
Klicke im Abschnitt „Code, Planung und Automatisierung“ der Seitenleiste auf Codespaces.
Klicke unter „Codespace-Geheimnisse“ rechts neben dem Geheimnis, das du löschen möchtest, auf Löschen.
Lies die Warnung, und klicke dann auf OK.

Verwenden von Geheimnissen

Ein Geheimnis einer Entwicklungsumgebung wird als Umgebungsvariable in die Terminalsitzung des Benutzers exportiert.

Screenshot des Terminals in VS Code Der Befehl „echo $EXAMPLE_API_KEY“ hat „aBCdeFG1234567“ zurückgegeben.

Du kannst Geheimnisse der Entwicklungsumgebung verwenden, wenn der Codespace erstellt wurde und ausgeführt wird. Ein Geheimnis kann beispielsweise in folgenden Fällen verwendet werden:

Beim Starten einer Anwendung über das integrierte Terminal oder die SSH-Sitzung.
Innerhalb des Lebenszyklusskripts eines Entwicklungscontainers, das nach Ausführung des Codespaces ausgeführt wird. Weitere Informationen zu Lebenszyklusskripts von Entwicklungscontainern findest du in der Dokumentation auf der Website zu Entwicklungscontainern: Spezifikation.

Geheimnisse der Entwicklungsumgebung können nicht verwendet werden:

Während der Codespacebuildzeit (d. h., innerhalb einer Dockerfile oder eines benutzerdefinierten Einstiegspunkts)
Innerhalb eines Entwicklungscontainerfeatures. Weitere Informationen findest du in der features-Eigenschaft in der Entwicklungscontainerspezifikation auf der Website zu Entwicklungscontainern.