Note
GitHub Codespaces ist nicht in Subdomänen von GHE.com verfügbar, z. B. in octocorp.ghe.com.
Informationen zum Erstellen eines Codespaces für ein Repository
Sie können einen Codespace auf GitHub, in Visual Studio Code oder mit der GitHub CLI erstellen. Verwende die Registerkarten in diesem Artikel, um Anweisungen für jede dieser Möglichkeiten zum Erstellen eines Codespaces anzuzeigen.
Sie können GitHub Codespaces für Ihr persönliches GitHub-Konto verwenden, wobei das Kontingent der kostenlosen Nutzung jeden Monat für Konten im Free- und Pro-Tarif enthalten ist. Du kannst GitHub Codespaces über deine monatlich enthaltene Speicher- und Computenutzung hinaus weiterhin verwenden, indem du Zahlungsdetails angibst und ein Ausgabenlimit festlegst. Weitere Informationen finden Sie unter „Informationen zur Abrechnung für GitHub Codespaces“.
Organisationen können Mitgliedern und externen Mitarbeitern das Erstellen und Verwenden von Codespaces auf Kosten der Organisation ermöglichen. Weitere Informationen findest du unter Auswählen der Besitzerinnen und Zahlerinnen von Codespaces in deiner Organisation.
Die Möglichkeit zum Erstellen von Codespaces aus organisationseigenen Repositorys hängt von mehreren Faktoren ab, unter anderem von der Sichtbarkeit des Repositorys und den Einstellungen der Organisation oder ihres übergeordneten Unternehmens. Weitere Informationen findest du unter Problembehandlung beim Erstellen und Löschen von Codespaces.
Hinweis: Wenn du über verwaltetes Benutzerkonto verfügst, kannst du nur dann Codespaces für deine persönlichen Repositorys erstellen, wenn das Repository ein Fork eines organisationseigenen Repositorys ist und du GitHub Codespaces auf Kosten der Organisation verwenden darfst. Weitere Informationen findest du unter Informationen zu Enterprise Managed Users.
Wenn du ein neues Projekt startest, kannst du einen Codespace über eine Vorlage erstellen und später in einem Repository in GitHub Enterprise Cloud veröffentlichen. Weitere Informationen findest du unter Erstellen eines Codespaces aus einer Vorlage.
Hinweis: Wenn du eine JetBrains-IDE verwendest, kannst du GitHub CLI verwenden, um einen Codespace zu erstellen. Anschließend kannst du die JetBrains Gateway-Anwendung verwenden, um den Codespace in einer JetBrains-IDE zu öffnen. Weitere Informationen findest du unter Verwenden von GitHub Codespaces in der JetBrains-IDE.
Wenn du einen Codespace aus einem Repository erstellst, wird der Codespace einem bestimmten Branch zugeordnet, der nicht leer sein kann. Du kannst pro Repository oder sogar pro Branch mehr als einen Codespace erstellen.
Du kannst alle verfügbaren Codespaces anzeigen, die du unter github.com/codespaces erstellt hast. Zum Anzeigen dieser Seite wählen Sie in der oberen linken Ecke von GitHub aus und klicken dann auf Codespaces. Dadurch gelangst du zu github.com/codespaces.
Der Codespace-Erstellungsprozess
Wenn du einen Codespace erstellst, erfolgt eine Reihe von Schritten zum Erstellen und Herstellen einer Verbindung mit deiner Entwicklungsumgebung:
- Schritt 1: VM und Speicher werden deinem Codespace zugewiesen.
- Schritt 2: Der Container wird erstellt, und dein Repository wird geklont.
- Schritt 3: Du kannst eine Verbindung mit dem Codespace herstellen.
- Schritt 4: Der Codespace wird mit dem Setup nach der Erstellung fortgesetzt.
Weitere Informationen dazu, was beim Erstellen eines Codespaces passiert, findest du unter Ausführliche Informationen zu GitHub Codespaces.
Weitere Informationen zum Lebenszyklus eines Codespaces findest du unter Grundlegendes zum Codespacelebenszyklus.
Wenn du Git-Hooks für deinen Codespace verwenden möchtest, solltest du die Hooks mithilfe der devcontainer.json-Lebenszyklusskripts einrichten, z. B. postCreateCommand. Diese werden in Schritt 4 oben ausgeführt. Informationen zu Lebenszyklusskripts findest du in der Spezifikation von Entwicklungscontainern auf der Website zu Entwicklungscontainern. Da der Dev-Container für Ihren Codespace erstellt wird, nachdem das Repository geklont wurde, gelten alle im Dev-Containerimage konfigurierten Git-Vorlagenverzeichnisse nicht für Ihren Codespace. Hooks müssen stattdessen installiert werden, nachdem der Codespace erstellt wurde.
Während der Entwicklung in einem Codespace mit VS Code kannst du Code bearbeiten, debuggen und Git-Befehle verwenden. Weitere Informationen findest du in der VS Code documentation.
Um die Erstellung von Codespaces zu beschleunigen, können Repositoryadministrator*innen GitHub Codespaces-Prebuilds für ein Repository aktivieren. Weitere Informationen findest du unter Weitere Informationen zu GitHub Codespaces-Prebuilds.
Erstellen eines Codespaces für ein Repository
-
Navigieren Sie auf GitHub zur Hauptseite des Repositorys.
-
Wähle unter dem Repositorynamen das Dropdownmenü „Branch“ aus, das den Namen des aktuellen Branchs aufweist, und klicke dann auf den Branch, für den du einen Codespace erstellen möchtest.
-
Klicke auf die Schaltfläche Code und dann auf die Registerkarte Codespaces.
Am unteren Rand des Dialogfelds wird eine Meldung angezeigt, die dich darüber informiert, wer für den Codespace bezahlt.
-
Erstelle deinen Codespace entweder mithilfe der Standardoptionen oder nach dem Konfigurieren erweiterter Optionen:
-
Verwenden der Standardoptionen
Um einen Codespace mit den Standardoptionen zu erstellen, klicke auf .
-
Konfigurieren der erweiterten Optionen
So konfigurierst du erweiterte Optionen für deinen Codespace, z. B. einen anderen Computertyp oder eine bestimmte Datei
devcontainer.json:-
Wähle rechts oben auf der Registerkarte Codespaces die drei Punkte aus, und klicke auf Neu mit Optionen.
-
Wähle auf der Seite „Optionen“ für deinen Codespace deine bevorzugten Optionen aus den Dropdownmenüs aus.
Auf der Optionsseite werden möglicherweise auch die Namen eines oder mehrerer Geheimnisse angezeigt, die du in deinen Codespaces-Einstellungen erstellen solltest. Weitere Informationen findest du unter Empfohlene Geheimnisse.
Hinweise
- Du kannst die Optionsseite mit einer Textmarke versehen, damit du schnell einen Codespace für dieses Repository und diesen Branch erstellen kannst.
- Die Seite https://github.com/codespaces/new bietet eine schnelle Möglichkeit, einen Codespace für jedes Repository und jeden Branch zu erstellen. Du kannst schnell zu dieser Seite gelangen, indem du
codespace.newin die Adressleiste deines Browsers eingibst. - Weitere Informationen zur Konfigurationsdatei für den Entwicklungscontainer findest du unter Einführung in Entwicklungscontainer.
- Weitere Informationen zu Computertypen findest du unter Ändern des Computertyps für deinen Codespace.
- Die zur Auswahl stehenden Computertypen können durch eine Reihe von Faktoren eingeschränkt werden. Hierzu zählen eine für deine Organisation konfigurierte Richtlinie oder eine Mindestspezifikation für Computertypen für dein Repository. Weitere Informationen findest du unter Einschränken des Zugriffs auf Computertypen und unter Festlegen einer Mindestspezifikation für Codespacecomputer.
-
Klicke auf Codespace erstellen.
-
-
Empfohlene Geheimnisse
Die Namen benutzerdefinierter Geheimnisse werden eventuell auf der Seite mit den erweiterten Optionen angezeigt, wenn du einen Codespace erstellst. Dies ist der Fall, wenn die empfohlenen Geheimnisse in der von dir ausgewählten Konfiguration des Entwicklungscontainers angegeben sind. Weitere Informationen findest du unter Angeben empfohlener Geheimnisse für ein Repository.
Die Eingabe von Werten für diese Entwicklungsumgebungs-Geheimnisse wird empfohlen, wenn Sie dazu aufgefordert werden, da Ihr Projekt wahrscheinlich Werte für diese Geheimnisse benötigt. Die Angabe von Werten ist jedoch nicht erforderlich, um einen Codespace zu erstellen. Du kannst diese Geheimnisse auch im Codespace festlegen, wenn du möchtest.
Wenn du einen Wert für ein empfohlenes Geheimnis eingibst, wird das Geheimnis im neuen Codespace verfügbar sein. Wenn du auf Codespace erstellen klickst, wird das Geheimnis auch deinen persönlichen Einstellungen für Codespaces hinzugefügt. Dann musst du in Zukunft keinen Wert mehr für das Geheimnis eingeben, wenn du einen Codespace für dieses Repository erstellst.
Wenn der Name eines Geheimnisses mit einem Kontrollkästchen angezeigt wird, das nicht aktiviert werden kann, und ohne Eingabefeld, liegt dies daran, dass du bereits ein Geheimnis mit diesem Namen in deinen persönlichen Codespaces-Einstellungen konfiguriert und diesem Repository zugeordnet hast. Wenn du ein Geheimnis mit diesem Namen erstellt, es diesem Repository aber nicht zugeordnet hast, ist das Kontrollkästchen aktivierbar. Dadurch kannst du die Einstellungen aktualisieren und die Zuordnung hinzufügen.
Wenn du den Wert eines vordefinierten Geheimnisses ändern möchtest, kannst du dies in deinen persönlichen Codespaces-Einstellungen unter github.com/settings/codespaces tun. Weitere Informationen findest du unter Verwalten deiner kontospezifischen Geheimnisse für GitHub Codespaces.
Nachdem Sie Ihr Konto auf GitHub mit der Erweiterung GitHub Codespaces verbunden haben, können Sie einen neuen Codespace erstellen. Weitere Informationen über die GitHub Codespaces-Erweiterung findest im VS Code Marketplace.
-
Klicke auf der linken Aktivitätsleiste von VS Code auf das Symbol „Remote-Explorer“.
Hinweis: Wenn der Remote-Explorer nicht in der Aktivitätsleiste angezeigt wird:
- Öffne die Befehlspalette. Zum Beispiel durch Drücken von UMSCHALT+Befehlstaste+P (Mac) / STRG+UMSCHALT+P (Windows/Linux).
- Geben Sie Folgendes ein:
details. - Klicke auf Codespaces: Details.
-
Zeige auf die Seitenleiste „Remote-Explorer“, und klicke auf .
-
Gib den Namen des Repositorys, in dem du entwickeln möchtest, in das Textfeld ein, und wähle es anschließend aus.
Rechts neben den nachfolgenden Eingabeaufforderungen wird eine Meldung angezeigt, die dich darüber informiert, wer für den Codespace bezahlt.
-
Klicke auf den Branch, in dem du entwickeln möchtest.
-
Wenn du zur Auswahl einer Dev-Containerkonfigurationsdatei aufgefordert wirst, wähle eine Datei in der Liste aus.
-
Klicke auf den gewünschten Computertyp.
Note
Die zur Auswahl stehenden Computertypen können durch eine Reihe von Faktoren eingeschränkt werden. Hierzu zählen eine für deine Organisation konfigurierte Richtlinie oder eine Mindestspezifikation für Computertypen für dein Repository. Weitere Informationen findest du unter Einschränken des Zugriffs auf Computertypen und unter Festlegen einer Mindestspezifikation für Codespacecomputer.
Weitere Informationen zur GitHub CLI findest du unter Informationen zur GitHub CLI.
Verwende zum Erstellen eines neuen Codespaces den Unterbefehl gh codespace create.
gh codespace create
Du wirst aufgefordert, ein Repository auszuwählen. In einer Meldung wirst du darüber informiert, wer für den Codespace bezahlt. Du wirst dann aufgefordert, einen Branch, eine Entwicklungscontainer-Konfigurationsdatei (sofern mehrere vorhanden sind) und einen Computertyp (sofern mehrere vorhanden sind) auszuwählen.
Alternativ kannst du Flags verwenden, um einige oder alle Optionen anzugeben:
gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE
In diesem Beispiel ersetze owner/repo durch den Repositorybezeichner. Ersetze branch durch den Namen des Branch oder den vollständigen SHA-Hash des Commits, den du zunächst im Codespace auschecken möchtest. Wenn du das -r-Flag ohne das b-Flag verwendest, wird der Codespace aus dem Standardbranch erstellt.
Ersetze path durch den Pfad zur Dev-Containerkonfigurationsdatei, die du für den neuen Codespace verwenden möchtest. Wenn du dieses Flag auslässt und mehrere Dev-Containerdateien verfügbar sind, wirst du aufgefordert, eine davon in einer Liste auszuwählen. Weitere Informationen zur Konfigurationsdatei für den Entwicklungscontainer findest du unter Einführung in Entwicklungscontainer.
Ersetze machine-type durch einen gültigen Bezeichner für einen verfügbaren Computertyp. Bezeichner sind Zeichenfolgen wie basicLinux32gb und standardLinux32gb. Der Typ der verfügbaren Computer hängt vom Repository, deinem persönlichen Konto und deinem Standort ab. Wenn du einen ungültigen oder nicht verfügbaren Computertyp eingibst, werden die verfügbaren Typen in der Fehlermeldung angezeigt. Wenn du dieses Flag auslässt und mehrere Computertypen verfügbar sind, wirst du aufgefordert, einen Typ aus einer Liste auszuwählen.
Ausführliche Informationen zu den Optionen für diesen Befehl findest du im GitHub CLI-Handbuch.