Informationen zum Erstellen eines Codespaces für ein Repository
Du kannst einen Codespace auf GitHub.com, 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.
Wenn du ein neues Projekt startest, kannst du einen Codespace über eine Vorlage erstellen und später in einem Repository in GitHub 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.
Du kannst GitHub Codespaces für dein persönliches GitHub.com-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 findest du 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 Aktivieren von GitHub Codespaces für deine Organisation.
Jeder von Dir erstellte Codespace steht nur Dir zur Verfügung. Niemand sonst kann in Deinem Codespace arbeiten.
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.
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 Der Codespace-Lebenszyklus.
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 dein Codespace-Container erstellt wird, nachdem das Repository geklont wurde, gelten alle im Containerimage konfigurierten Git-Vorlagenverzeichnisse nicht für deinen 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
-
Navigiere auf GitHub.com zur Hauptseite des Repositorys.
-
Wähle im Dropdownmenü „Branch“ unterhalb des Repositorynamens den Branch aus, für den du einen Codespace erstellen möchtest.
-
Klicke auf die Schaltfläche Code und dann auf die Registerkarte Codespaces.
Wenn Codespaces für dieses Repository einer Organisation oder dem übergeordneten Unternehmen in Rechnung gestellt werden können, wird unterhalb der Schaltfläche Codespace auf BRANCH erstellen eine Mitteilung angezeigt, 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 das Pluszeichen (). Wenn du derzeit keine Codespaces für dieses Repository hast, kannst du alternativ auf Codespace in BRANCH erstellen klicken.
-
Konfigurieren von Optionen
So konfigurierst du erweiterte Optionen für deinen Codespace, z. B. einen anderen Computertyp oder eine bestimmte Datei
devcontainer.json
:-
Klicke oben rechts auf der Registerkarte Codespaces auf die Auslassungspunkte ( ... ), und wähle dann Neu mit Optionen aus.
-
Wähle auf der Seite „Optionen“ für deinen Codespace deine bevorzugten Optionen aus den Dropdownmenüs aus.
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.new
in die Adressleiste deines Browsers eingibst. - Weitere Informationen zur
devcontainer.json
-Datei 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.
-
-
Nachdem du dein Konto auf GitHub.com mit der Erweiterung GitHub Codespaces verbunden hast, kannst du 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.
Wenn sich das ausgewählte Repository im Besitz einer Organisation befindet und die Organisation Codespaces für dieses Repository so konfiguriert hat, dass sie für die Organisation oder das übergeordnete Unternehmen in Rechnung gestellt werden, wird in den nachfolgenden Eingabeaufforderungen 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.
Hinweis: 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. Wenn Codespaces für dieses Repository einer Organisation oder dem übergeordneten Unternehmen in Rechnung gestellt werden können, wird eine Mitteilung angezeigt, 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.