Personalisieren von GitHub Codespaces für dein Konto

Du kannst GitHub Codespaces personalisieren, indem du ein dotfiles-Repository in GitHub Enterprise Cloud oder die Einstellungssynchronisierung verwendest.

In diesem Artikel

Informationen zur Personalisierung von Codespaces

Bei Verwendung einer Entwicklungsumgebung ist das Anpassen der Einstellungen und Tools an deine Präferenzen und Workflows ein wichtiger Schritt. In GitHub Codespaces gibt es zwei mögliche Hauptmethoden zur Personalisierung deiner Codespaces.

  • Einstellungssynchronisierung: Du kannst deine Visual Studio Code-Einstellungen zwischen der Desktopanwendung und dem VS Code-Webclient synchronisieren.
  • Dotfiles: Du kannst ein dotfiles-Repository verwenden, um Skripts, Shelleinstellungen und andere Konfigurationen anzugeben.

Die Personalisierung von GitHub Codespaces gilt für alle Codespaces, die du erstellst.

Projektbetreuer können auch eine Standardkonfiguration definieren, die für jeden Codespace eines Repositorys gilt, egal wer ihn erstellt. Weitere Informationen findest du unter Einführung in Entwicklungscontainer.

Einstellungssynchronisierung

Mit der Einstellungssynchronisierung kannst du Konfigurationen wie Einstellungen, Tastenkombinationen, Codeschnipsel, Erweiterungen und Benutzeroberflächenstatus zwischen verschiedenen Computern und VS Code-Instanzen synchronisieren. Weitere Informationen findest du unter Einstellungssynchronisierung in der VS Code-Dokumentation.

Deine synchronisierten Einstellungen werden in der Cloud zwischengespeichert. Wenn die Einstellungssynchronisierung in einem Codespace aktiviert ist, werden alle Updates, die du an deinen Einstellungen im Codespace vornimmst, in die Cloud gepusht, und alle Updates, die du von einem anderen Ort in die Cloud pushst, werden in deinen Codespace gepullt.

Eine häufige Verwendung der Einstellungssynchronisierung wäre zum Beispiel die Synchronisierung deiner Einstellungen deiner VS Code-Desktopanwendung, die du für die lokale Arbeit verwendest, mit den Codepaces, die du im Browser öffnest. Dazu musst du die folgenden Schritte ausführen.

Alternativ kannst du dieselben Einstellungen für alle Codespaces verwenden, die du im Webclient öffnest, während deine lokale VS Code-Anwendung nicht betroffen ist. Dazu musst du die folgenden Schritte ausführen.

  • Konfiguriere in einem Codespace deine Einstellungen nach deinen Wünschen, und aktiviere dann Einstellungssynchronisierung im Codespace, um die Einstellungen in die Cloud zu übertragen. In diesem Fall wird die Einstellungssynchronisierung automatisch in deinen Benutzereinstellungen für GitHub Codespaces aktiviert, sodass deine Einstellungen in alle neuen Codespaces gepullt werden. Weitere Informationen findest du unter Aktivieren der Einstellungssynchronisierung in einem Codespace.
  • Lasse in der Desktopanwendung die Einstellungssynchronisierung deaktiviert, oder synchronisiere deine Einstellungen mit einem anderen Konto.

Informationen zur Einstellungssynchronisierung in Codespaces

Ob die Einstellungssynchronisierung in einem Codespace standardmäßig aktiviert ist, und welche Beziehung zwischen den zwischengespeicherten Einstellungen und den Einstellungen in einem Codespace besteht, hängt von mehreren Faktoren ab. Zu diesen Faktoren gehören der Editor, in dem du den Codespace öffnest, deine Benutzereinstellungen für GitHub und deine Liste vertrauenswürdiger Repositorys.

Für Codespaces, die in der VS Code-Desktopanwendung geöffnet wurden, bleibt die Einstellungssynchronisierung aktiviert, wenn du die Einstellungssynchronisierung zuvor in der Anwendung aktiviert hast. Wenn die Einstellungssynchronisierung aktiviert ist, werden deine Einstellungen in beiden Richtungen mit der Cloud synchronisiert.

Für Codespaces, die im VS Code-Webclient geöffnet werden, ist die Einstellungssynchronisierung standardmäßig deaktiviert. Dies bedeutet, dass die VS Code-Instanz im Codespace das Standarddesign und die Standardeinstellungen verwendet.

Wenn du den Webclient verwendest und möchtest, dass deine Codespaces deine zwischengespeicherten synchronisierten Einstellungen verwenden, kannst du die Einstellungssynchronisierung in deinen Benutzereinstellungen unter GitHub aktivieren. Weitere Informationen findest du unter Verwalten deiner Einstellungen für die Einstellungssynchronisierung. Die Einstellungssynchronisierung wird in deinen Benutzereinstellungen automatisch aktiviert, wenn du einen Codespace im Webclient öffnest und die Einstellungssynchronisierung im Codespace aktivierst.

Wenn die Einstellungssynchronisierung in deinen Benutzereinstellungen aktiviert ist, hängt das Verhalten der Einstellungssynchronisierung für Codespaces, die im Webclient geöffnet werden, von deiner Liste der vertrauenswürdigen Repositorys ab.

  • Wenn du einen Codespace aus einem Repository erstellst, dem du vertraust, ist die Einstellungssynchronisierung standardmäßig im Codespace aktiviert, sodass deine Einstellungen in beiden Richtungen mit der Cloud synchronisiert werden.

  • Wenn du einen Codespace aus einem Repository erstellst, das du deiner Liste vertrauenswürdiger Repositorys nicht hinzugefügt hast, erfolgt die Synchronisierung in eine Richtung und nur zu einem Zeitpunkt. Wenn du den Codespace erstellst, werden deine Einstellungen aus deinen zwischengespeicherten Einstellungen in der Cloud in den Codespace gepullt, aber ab dann wird die Einstellungssynchronisierung im Codespace deaktiviert. Dies bedeutet, dass Updates, die du an deinen Einstellungen im Codespace vornimmst, nicht zurück in die Cloud gepusht werden, und alle Updates, die du an deinen zwischengespeicherten Einstellungen von anderswo aus vornimmst, werden nicht im Codespace widergespiegelt, nachdem du sie erstellt hast.

    Wenn du die Einstellungssynchronisierung in einem Codespace aktivierst, wirst du aufgefordert, das Repository deiner Liste vertrauenswürdiger Repositorys hinzuzufügen. Weitere Informationen findest du unter Aktivieren der Einstellungssynchronisierung in einem Codespace.

Deine Liste vertrauenswürdiger Repositorys für GitHub Codespaces wird von den GpG-Überprüfungs- und Einstellungssynchronisierungsfeatures gemeinsam genutzt. Wenn du beide Features aktiviert hast und eine ausgewählte Liste vertrauenswürdiger Repositorys für die GPG-Überprüfung hinzugefügt hast, wird die Einstellungssynchronisierung in Codespaces aktiviert, die in diesen Repositorys erstellt wurden. Wenn du einem neuen Repository für die Einstellungssynchronisierung vertraust, ist die GPG-Überprüfung für dasselbe Repository aktiviert. Obwohl die Features dieselbe Liste vertrauenswürdiger Repositorys verwenden, kannst du GPG-Überprüfung und Einstellungssynchronisierung unabhängig voneinander aktivieren oder deaktivieren.

Hinweis: Wenn du die GPG-Überprüfung zuvor für alle Repositorys aktiviert hast, solltest du deine Einstellungen so ändern, dass eine ausgewählte Liste vertrauenswürdiger Repositorys verwendet wird. Weitere Informationen findest du unter Sicherheit in GitHub Codespaces.

Weitere Informationen zum Verwalten deiner Einstellungen für die GPG-Überprüfung findest du unter Verwalten der GPG-Überprüfung für GitHub Codespaces.

Verwalten deiner Einstellungen für die Einstellungssynchronisierung

Wenn du die Einstellungssynchronisierung in deinen Benutzereinstellungen aktivierst, werden Codespaces, die im VS Code-Webclient geöffnet sind, deine zwischengespeicherten Einstellungen aus der Cloud pullen, und in vertrauenswürdigen Repositorys erstellte Codespaces werden in beiden Richtungen mit deinen zwischengespeicherten Einstellungen synchronisiert.

  1. Klicken Sie auf einer beliebigen Seite auf GitHub oben rechts auf Ihr Profilfoto und dann auf Einstellungen.

  2. Klicke im Abschnitt „Code, Planung und Automatisierung“ der Seitenleiste auf Codespaces.

  3. Um die Einstellungssynchronisierung zu aktivieren oder zu deaktivieren, wähle unter „Einstellungssynchronisierung“ die Option Aktivieren aus, oder deaktiviere sie.

  4. Um deine vertrauenswürdigen Repositorys für GPG-Überprüfung und Einstellungssynchronisierung zu ändern, wähle unter „Vertrauenswürdige Repositorys“ entweder Alle Repositorys aus, oder wähle Ausgewählte Repositorys aus, und verwende die Dropdownliste „Repositorys auswählen“, um Repositorys hinzuzufügen, denen du vertraust.

    Hinweis: Du solltest eine ausgewählte Liste vertrauenswürdiger Repositorys verwenden. Weitere Informationen findest du unter Sicherheit in GitHub Codespaces.

Deine Updates werden in neuen Codespaces wirksam. Du kannst jedoch die Einstellungssynchronisierung in einem vorhandenen Codespace aktivieren. Weitere Informationen findest du unter Aktivieren der Einstellungssynchronisierung in einem Codespace.

Aktivieren der Einstellungssynchronisierung in einem Codespace

Hinweis: Du solltest die Einstellungssynchronisierung nur in Codespaces aktivieren, die in vertrauenswürdigen Repositorys erstellt wurden. Weitere Informationen findest du unter Sicherheit in GitHub Codespaces.

Im Folgenden wird beschrieben, wie du die Einstellungssynchronisierung in einem Codespace aktivierst, der im Webclient geöffnet ist. Informationen zum Aktivieren der Einstellungssynchronisierung in der VS Code-Desktopanwendung findest du unter Einstellungssynchronisierung in der VS Code-Dokumentation.

  1. Wähle in VS Code im unteren Bereich der Aktivitätsleiste das Symbol aus, und klicke auf Bei Einstellungssynchronisierung anmelden.

  2. Wenn sich das Repository, in dem du den Codespace erstellt hast, nicht in deiner Liste vertrauenswürdiger Repositorys befindet, wird ein Browserfenster geöffnet, in dem du aufgefordert wirst, zusätzliche Berechtigungen für die Einstellungssynchronisierung zu autorisieren. Wenn du dem Repository vertraust, klicke auf Autorisieren, und schließe dann das Browserfenster. Der Codespace wird neu geladen und zeigt deine neuesten synchronisierten Einstellungen an.

    Hinweis: Wenn du die Einstellungssynchronisierung in deinen Benutzereinstellungen deaktiviert und alle Repositorys als deine vertrauenswürdigen Repositorys festgelegt hast, wird eine Warnung zum Aktivieren der Einstellungssynchronisierung für alle Repositorys angezeigt. Überprüfe die Warnung, und wähle aus, ob du die Einstellungssynchronisierung für alle Repositorys aktivieren oder deine Liste vertrauenswürdiger Repositorys überarbeiten möchtest.

  3. Um zu konfigurieren, welche Einstellungen du synchronisieren möchtest, öffne die Befehlspalette mitUMSCHALT+COMMAND+P (Mac)/STRG+UMSCHALT+P (Windows/Linux), und gib dann „Einstellungssynchronisierung“ ein. Klicke auf Einstellungssynchronisierung: Konfigurieren... .

  4. Wähle die zu synchronisierenden Einstellungen aus, und klicke auf OK.

    Screenshot: Optionen für die Einstellungssynchronisierung. Die sieben vorhandenen Optionen verfügen jeweils über ein Kontrollkästchen. Die Schaltfläche „OK“ wird oben rechts angezeigt.

Deaktivieren der Einstellungssynchronisierung in einem Codespace

Du kannst die Einstellungssynchronisierung deaktivieren, um das Synchronisieren von Einstellungen in beiden Richtungen mit einer Instanz von VS Code zu beenden.

Wenn du die Einstellungssynchronisierung in einem Codespace deaktivierst, verwenden neue Codespaces weiterhin die Einstellungen, die seit dem letzten Push deiner Einstellungen in die Cloud zwischengespeichert wurden. Wenn du den VS Code-Webclient für Codespaces verwendest und möchtest, dass Codespaces die Standardeinstellungen anstelle deiner zwischengespeicherten Einstellungen verwenden, kannst du die Einstellungssynchronisierung deaktivieren. Weitere Informationen findest du unter Verwalten deiner Einstellungen für die Einstellungssynchronisierung.

Wenn du zur Verwendung der VS Code-Standardeinstellungen in allen Instanzen von VS Code einschließlich der Desktopanwendung zurückkehren möchtest, kannst du den Cache in der Cloud löschen, wenn du die Einstellungssynchronisierung deaktivierst.

  1. Wenn die Einstellungssynchronisierung in deiner Instanz von VS Code derzeit deaktiviert ist, und du deine zwischengespeicherten Einstellungen löschen möchtest, musst du sie zuerst aktivieren. Anweisungen findest du unter Personalisieren von GitHub Codespaces für dein Konto.

  2. Wähle unten auf der Aktivitätsleiste aus, und klicke auf Einstellungssynchronisierung ist aktiviert.

  3. Klicke in der Dropdownliste auf Einstellungssynchronisierung: Deaktivieren.

    Screenshot des Dropdownmenüs mit hervorgehobener Option „Einstellungssynchronisierung: Deaktivieren“ mit dunkelorangenem Rahmen.

  4. Um die zwischengespeicherten Einstellungen zu löschen, wähle im Dialogfeld Synchronisierung auf allen Geräten deaktivieren und die Daten aus der Cloud löschen aus.

    Screenshot des Dialogfelds: „Möchten Sie die Synchronisierung deaktivieren?“. Die Option zum Löschen von Daten aus der Cloud ist ausgewählt.

  5. Klicke auf Deaktivieren.

Dotfiles

Dotfiles sind Dateien und Ordner auf UNIX-ähnlichen Systemen, die mit . beginnen und von denen die Konfiguration von Anwendungen und Shells auf deinem System gesteuert wird. Du kannst deine 'dotfiles' in einem Repository auf GitHub speichern und verwalten. Empfehlungen und Tutorials hinsichtlich der Frage, welche Elemente du in dein Dotfiles-Repository aufnehmen solltest, findest du unter GitHub und Dotfiles.

Dein Dotfiles-Repository könnte Shell-Aliase und -Voreinstellungen beinhalten, sämtliche Werkzeuge, die du installieren möchtest, oder jede andere Codespace-Personalisierung, die du vornehmen möchtest.

Du kannst GitHub Codespaces so konfigurieren, dass Dotfiles aus einem beliebigen Repository verwendet werden, das du besitzt, indem du das betreffende Repository in deinen persönlichen GitHub Codespaces-Einstellungen auswählst.

Wenn du einen neuen Codespace erstellst, wird das ausgewählte Dotfilerepository von GitHub in die Codespaceumgebung geklont. Außerdem wird zum Einrichten der Umgebung nach einer der folgenden Dateien gesucht.

  • install.sh
  • install
  • bootstrap.sh
  • bootstrap
  • script/bootstrap
  • setup.sh
  • setup
  • script/setup

Wenn keine dieser Dateien gefunden wird, werden alle Dateien oder Ordner in deinem ausgewählten Dotfiles-Repository, die mit . beginnen, per Symlink mit dem Verzeichnis ~ oder $HOME des Codespaces verknüpft.

Am ausgewählten Dotfiles-Repository vorgenommene Änderungen gelten nur für neue Codespaces und wirken sich nicht auf bestehende Codespaces aus.

Hinweis: Derzeit bietet Codespaces keine Unterstützung für die Personalisierung der Benutzereinstellungen für VS Code über dein dotfiles-Repository. Du kannst Standardeinstellungen für Workspace (Arbeitsbereich) und Remote [Codespaces] für ein bestimmtes Projekt im Repository des Projekts festlegen. Weitere Informationen findest du unter Einführung in Entwicklungscontainer.

Aktivieren des Dotfiles-Repositorys für Codespaces

Du kannst dein ausgewähltes Dotfilerepository verwenden, um deine GitHub Codespaces-Umgebung zu personalisieren. Nachdem du dein Dotfiles-Repository ausgewählt hast, kannst du deine Skripts, Einstellungen und Konfigurationen hinzufügen. Anschließend musst du deine Dotfiles über deine persönliche GitHub Codespaces-Einstellungsseite aktivieren.

Warnung: Von Dotfiles können beliebige Skripts ausgeführt werden, die unerwarteten oder böswilligen Code enthalten können. Es wird empfohlen, Skripts vor dem Installieren eines Dotfiles-Repositorys zu überprüfen und so sicherzustellen, dass von den Skripts keine unerwarteten Aktionen ausgeführt werden.

  1. Klicken Sie auf einer beliebigen Seite auf GitHub oben rechts auf Ihr Profilfoto und dann auf Einstellungen.

  2. Klicke im Abschnitt „Code, Planung und Automatisierung“ der Seitenleiste auf Codespaces.

  3. Wähle unter „Dotfiles“ die Option Dotfiles automatisch installieren aus, damit GitHub Codespaces deine Dotfiles automatisch in jedem neuen Codespace installiert, den du erstellst.

    Screenshot: Abschnitt „Dotfiles“ der Codespaceeinstellungen mit deaktivierter Option „Dotfiles automatisch installieren“

  4. Wähle über die Dropdownliste das Repository aus, aus dem du Dotfiles installieren möchtest.

    Screenshot: Aktivierte Option „Dotfiles automatisch installieren“ und ausgewählte Option „monalisa/dotfiles“ in einer Dropdownliste mit Repositorys

Du kannst dem Dotfiles-Repository weitere Skripts, Einstellungen und Konfigurationsdateien hinzufügen oder vorhandene Dateien bearbeiten, wann immer du dies möchtest. An Einstellungen vorgenommene Änderungen werden nur von neuen Codespaces übernommen.

Wenn dein Codespace die Konfigurationseinstellungen aus Dotfiles nicht übernimmt, findest du weitere Informationen unter Problembehandlung bei Personalisierungsoptionen für GitHub Codespaces.

Andere verfügbare Einstellungen

Du kannst GitHub Codespaces auch mithilfe zusätzlicher Optionen in deinen persönlichen Einstellungen personalisieren:

Weitere Informationsquellen