Codespaces

Ein GitHub Codespace ist eine vollständig konfigurierte Entwicklungsumgebung, die in der Cloud gehostet wird.

Sie können von Ihrem Browser oder Ihrer lokalen Visual Studio Code-Installation aus eine Verbindung zu Codespaces herstellen. Alle persönlichen GitHub-Konten haben ein monatliches Kontingent für die kostenlose Nutzung von GitHub Codespaces im Free- oder Pro-Plan enthalten (siehe Preisinformationen).

Warnung

Sie haben nur ein begrenztes Kontingent an kostenlosen Stunden pro Monat, also vergessen Sie nicht, Ihren Codespace zu stoppen, wenn Sie fertig sind: Übersicht über den Codespaces-Status in GitHub

Unabhängig von Ihrem lokalen Betriebssystem läuft Ihr Codespace in einer Linux-Umgebung.

Einrichten eines GitHub Codespace

Schritt-für-Schritt-Anleitung:

  1. Navigieren Sie zu Ihrem Repository: Gehen Sie zu dem Repository, in dem Sie einen Codespace erstellen möchten.

  2. Klicken Sie auf ‘Code’: Klicken Sie auf der Hauptseite Ihres Repositorys auf die Schaltfläche ‘Code’.

  3. Wählen Sie ‘Mit Codespaces öffnen’: Wählen Sie im Dropdown-Menü die Option ‘Mit Codespaces öffnen’.

  4. Erstellen Sie einen neuen Codespace: Klicken Sie auf ‘Neuer Codespace’, um Ihre Entwicklungsumgebung zu erstellen.

Verbinden mit Codespaces

Verwenden des Browsers

  1. Öffnen Sie Ihren Codespace: Nachdem der Codespace erstellt wurde, können Sie direkt über Ihren Browser darauf zugreifen. Navigieren Sie zum ‘Codespaces’-Tab in Ihrem Repository und klicken Sie auf Ihren Codespace, um ihn zu öffnen.

Verwenden von Visual Studio Code

  1. Installieren Sie Visual Studio Code: Laden Sie Visual Studio Code herunter und installieren Sie es.

  2. Installieren Sie die GitHub Codespaces-Erweiterung: Gehen Sie zum Visual Studio Code Marketplace und installieren Sie die GitHub Codespaces-Erweiterung.

  3. Melden Sie sich bei GitHub an: Öffnen Sie Visual Studio Code, klicken Sie auf das Erweiterungs-Symbol in der Seitenleiste und melden Sie sich bei Ihrem GitHub-Konto an.

  4. Verbinden Sie sich mit Ihrem Codespace: Klicken Sie in Visual Studio Code auf das Symbol ‘Remote Explorer’ in der Seitenleiste, wählen Sie ‘Codespaces’ und wählen Sie Ihren Codespace aus der Liste aus, um eine Verbindung herzustellen.

Verwendung von GitHub Codespaces

Vorgefertigte Entwicklungsumgebung

GitHub Codespaces bietet eine vorgefertigte Entwicklungsumgebung mit:

  • VS Code-Erweiterungen: Automatisch installierte Erweiterungen, die im Repository definiert sind.
  • Docker-basierte Container: Die Entwicklungsumgebung läuft in einem Container und gewährleistet Konsistenz.
  • Vorinstallierte Tools: Gängige Entwicklungstools und Abhängigkeiten sind vorinstalliert.

Anpassen Ihres Codespace

Sie können Ihren Codespace anpassen, indem Sie Ihrem Repository ein Verzeichnis .devcontainer hinzufügen. Dieses Verzeichnis enthält Konfigurationsdateien, die die Entwicklungsumgebung definieren.

  1. Erstellen Sie ein .devcontainer-Verzeichnis: Erstellen Sie im Stammverzeichnis Ihres Repositorys ein Verzeichnis namens .devcontainer.

  2. Fügen Sie eine devcontainer.json-Datei hinzu: Fügen Sie im Verzeichnis .devcontainer eine devcontainer.json-Datei mit der Konfiguration für Ihre Umgebung hinzu.

Beispiel devcontainer.json:

{
  "name": "My Codespace",
  "image": "mcr.microsoft.com/vscode/devcontainers/python:3",
  "settings": {
    "terminal.integrated.shell.linux": "/bin/bash"
  },
  "extensions": [
    "ms-python.python",
    "ms-azuretools.vscode-docker"
  ],
  "postCreateCommand": "pip install -r requirements.txt"
}

Änderungen speichern

Alle Änderungen, die Sie in Ihrem Codespace vornehmen, können Sie wie in einer lokalen Entwicklungsumgebung committen und in Ihr Repository pushen.

Codespaces verwalten

Codespaces stoppen und löschen

Um Ihre Nutzung zu verwalten und das monatliche Kontingent nicht zu überschreiten, sollten Sie Codespaces stoppen oder löschen, wenn sie nicht in Gebrauch sind.

  1. Navigieren Sie zu Codespaces: Gehen Sie zum ‘Codespaces’-Tab in Ihrem Repository oder Ihrem GitHub-Profil.

  2. Einen Codespace stoppen oder löschen: Klicken Sie auf die drei Punkte neben Ihrem Codespace und wählen Sie ‘Codespace stoppen’ oder ‘Codespace löschen’.

Best Practices für die Nutzung von GitHub Codespaces

Effiziente Nutzung

  • Inaktive Codespaces stoppen: Stoppen Sie immer Ihre Codespaces, wenn sie nicht in Gebrauch sind, um Ihr Nutzungskontingent zu schonen.
  • Nutzung überwachen: Überprüfen Sie regelmäßig Ihre Codespaces-Nutzung, um sicherzustellen, dass Sie innerhalb Ihrer kostenlosen Kontingentgrenzen bleiben.

Anpassung

  • Docker-Images verwenden: Nutzen Sie Docker-Images, um eine konsistente Entwicklungsumgebung über verschiedene Codespaces hinweg zu gewährleisten.
  • Abhängigkeiten definieren: Verwenden Sie die devcontainer.json, um alle notwendigen Abhängigkeiten und Tools anzugeben.

Zusammenarbeit

  • Konfigurationen teilen: Teilen Sie .devcontainer-Konfigurationen innerhalb Ihres Teams, um eine konsistente Einrichtung zu gewährleisten.
  • Versionskontrolle: Committen Sie Ihr .devcontainer-Verzeichnis in die Versionskontrolle, um eine einfache Einrichtung in verschiedenen Umgebungen zu ermöglichen.

Fazit

GitHub Codespaces bietet eine leistungsstarke, cloudbasierte Entwicklungsumgebung, die die Einrichtung vereinfacht und die Zusammenarbeit verbessert. Indem Sie die in diesem Kapitel beschriebenen Schritte und Best Practices befolgen, können Sie GitHub Codespaces optimal für Ihre Entwicklungsprojekte nutzen.

Für ausführlichere Informationen, erkunden Sie die offizielle Dokumentation von GitHub Codespaces.

Tipp

Experimentieren Sie mit verschiedenen Konfigurationen in Ihrem .devcontainer-Verzeichnis, um Ihre Entwicklungsumgebung zu optimieren.