Einrichten eines Vorlagenrepositorys für GitHub Codespaces

In diesem Artikel

Du kannst Personen bei den ersten Schritten mit einem Projekt helfen, indem du ein Vorlagenrepository für die Verwendung mit GitHub Codespaces einrichtest.

Einführung

Indem du ein Vorlagenrepository einrichtest, kannst du Personen bei den ersten Schritten mit deinem Framework, deiner Bibliothek oder einem anderen Projekt in GitHub Codespaces helfen. Benutzer können deine Vorlagendateien sofort in einer cloudbasierten Entwicklungsumgebung verwenden, ohne sich Gedanken über das Klonen deines Repositorys oder die Installation von Tools oder anderen Abhängigkeiten machen zu müssen. Mit einigen Konfigurationsschritten kannst du Benutzer in einem Codespace einrichten, in dem wichtige Dateien bereits für die Bearbeitung geöffnet sind und in dem bereits eine Anwendung auf einer Vorschaubrowserregisterkarte im VS Code-Web-Editor ausgeführt wird.

Jeder Benutzer mit Lesezugriff auf dein Vorlagenrepository kann auf der Seite des Repositorys in GitHub einen Codespace erstellen. Du kannst jedes vorhandene Repository in eine Vorlage umwandeln, und du musst keine Einstellungen ändern, damit Benutzer einen Codespace aus deinem Vorlagenrepository erstellen können. Weitere Informationen zum Umwandeln eines Repositorys in eine Vorlage findest du unter Eine Repository-Vorlage erstellen.

Damit Benutzerinnen deine Vorlage schnell finden und direkt loslegen können, kannst du einen Link zur Codespace-Erstellungsseite für die Vorlage freigeben. Beispielsweise kannst du diesen Link in einem Tutorial für die ersten Schritte mit deinem Framework bereitstellen. Du kannst die Option „Deep-Link freigeben“ verwenden und Schnellstart auswählen, um einen Link zu erstellen, der Benutzerinnen zu einer Seite weiterleitet, auf der sie schnell einen neuen Codespace erstellen oder mit einem aktuellen Codespace weiterarbeiten können. Weitere Informationen findest du unter Vereinfachtes Erstellen und Fortsetzen von Codespaces.

Wenn ein Benutzer einen Codespace aus deiner Vorlage erstellt, wird der Inhalt deines Vorlagenrepositorys in seinem Codespace geklont. Wenn der Benutzer bereit ist, kann er seine Arbeit in einem neuen Repository in GitHub veröffentlichen, das zu seinem persönlichen Konto gehört. Weitere Informationen findest du unter Erstellen eines Codespaces aus einer Vorlage.

Organisationen können dafür bezahlen, dass Mitglieder der Organisation und externe Mitarbeiter GitHub Codespaces auf Kosten der Organisation verwenden. Dies bezieht Codespaces mit ein, die aus Vorlagenrepositorys im Besitz der Organisation erstellt wurden. Wenn Benutzerinnen jedoch in ihrem persönlichen Konto einen Codespace veröffentlichen, der aus einer Vorlage erstellt wurde, werden Besitz und Abrechnung des Codespaces an dieden Benutzerin übertragen, dieder den Codespace erstellt hat. Weitere Informationen findest du unter Informationen zur Abrechnung für GitHub Codespaces.

Beschreiben deiner Vorlage

Wenn du keine Infodatei für dein Vorlagenrepository besitzt, erstelle eine, um den Zweck deiner Vorlage und die ersten Schritte damit zu beschreiben. Weitere Informationen findest du unter Informationen zu README-Dateien.

Du kannst auch eine kurze Beschreibung deines Projekts angeben, indem du zur Seite des Repositorys navigierst und rechts neben dem Abschnitt Info auf klickst.

Screenshot: Abschnitt „Info“ auf einer Repositoryseite Die Schaltfläche „Einstellungen“ (Zahnradsymbol) ist mit einem dunkelorangefarbenen Umriss hervorgehoben.

Hinzufügen von Startdateien

Vorlagenrepositorys enthalten in der Regel Startdateien mit Codebausteinen, sodass Benutzer schnell mit einer Bibliothek, einem Framework oder einer anderen Technologie beginnen können.

Eine Anleitung zu den zu integrierenden Dateitypen findest du in den Startdateien, die in den offiziellen GitHub-Vorlagen für GitHub Codespaces enthalten sind:

  1. Navigiere zur Seite „Deine Codespaces“ unter github.com/codespaces.

  2. Um die vollständige Liste der Vorlagen anzuzeigen, klicke im Abschnitt „Schnellstartvorlagen durchsuchen“ auf Alle anzeigen.

    Screenshot: Abschnitt „Schnellstartvorlagen durchsuchen“. „Alle anzeigen“ ist dunkelorange umrandet.

  3. Um das Vorlagenrepository anzuzeigen, das die Dateien für die Vorlage enthält, klicke auf den Namen der Vorlage.

    Screenshot: Abschnitt „Schnellstartvorlagen durchsuchen“ auf der Codespaceseite. Die Namen der Vorlagen sind mit orangefarbenen Umrissen hervorgehoben.

Konfigurieren des Entwicklungscontainers

Du kannst deinem Vorlagenrepository Konfigurationsdateien für Entwicklungscontainer hinzufügen, um die Entwicklungsumgebung für Personen, die deine Vorlage verwenden, mit GitHub Codespaces anzupassen. Du kannst aus einer Liste vordefinierter Konfigurationseinstellungen in Visual Studio Code wählen oder eine benutzerdefinierte Konfiguration erstellen, indem du eine eigene Datei vom Typ devcontainer.json schreibst. Wenn du keine Konfigurationsdateien hinzufügst, wird das Standardcontainerimage verwendet. Weitere Informationen findest du unter Einführung in Entwicklungscontainer und unter Hinzufügen einer Entwicklungscontainerkonfiguration zu deinem Repository.

Hinweis: Wenn Benutzer Codespaces über die Schaltfläche Diese Vorlage verwenden in einem Vorlagenrepository erstellen, haben sie keine Wahl zwischen Konfigurationen. Der Codespace wird basierend auf der Standardkonfiguration erstellt, die in .devcontainer/devcontainer.json oder in .devcontainer.json im Stammverzeichnis deines Repositorys definiert ist.

Du solltest deinen Entwicklungscontainer mit den Tools und Anpassungen konfigurieren, um Benutzern eine optimale Nutzung deiner Vorlage zu ermöglichen. Gehe in deiner Datei devcontainer.json beispielsweise wie folgt vor:

  • Du kannst die openFiles-Eigenschaft verwenden, um eine Liste von Dateien zu definieren, die automatisch im VS Code-Webclient geöffnet werden sollen, wenn ein Codespace aus deiner Vorlage erstellt wird.
  • Wenn Benutzer*innen persönliche Geheimnisse wie API-Schlüssel angeben müssen, um die Anwendung in deiner Vorlage auszuführen, kannst du sie zur Bereitstellung dieser Geheimnisse auffordern. Weitere Informationen findest du unter Angeben empfohlener Geheimnisse für ein Repository.
  • Wenn deine Vorlage Dateien für eine Webanwendung enthält, kannst du die Anwendung automatisch im Codespace des Benutzers ausführen lassen. Dazu kannst du mithilfe der postAttachCommand-Eigenschaft ein Skript ausführen, das die Anwendung auf einem lokalen Server startet, sobald der VS Code-Webclient eine Verbindung mit dem Codespace herstellt. Lege außerdem die onAutoForward-Eigenschaft eines Ports auf openPreview fest, um die Anwendung, die an diesem Port ausgeführt wird, in einem einfachen Browser anzuzeigen, der in den VS Code-Webclient eingebettet ist.

Die folgenden Konfigurationseinstellungen für eine React-Vorlage öffnen die Datei app.js im Editor des Benutzers, führen npm start (in einer package.json-Datei definiert) aus, um einen lokalen Server zu starten, und leiten den Port 3000 an eine Vorschaubrowserregisterkarte im Codespace weiter.

{
    "postAttachCommand": {
      "server": "npm start"
    },

    "portsAttributes": {
      "3000": {
        "label": "Application",
        "onAutoForward": "openPreview"
      }
    },

    "customizations": {
      "codespaces": {
        "openFiles": ["src/App.js"]
      }
    }
}

Weitere Informationen findest du unter Automatisches Öffnen von Dateien in den Codespaces für ein Repository und in der Entwicklungscontainerspezifikation auf der Website für Entwicklungscontainer.