Fehlerbehebung bei prebuilds

Mit Prebuilds kannst du die Erstellung von Codespaces beschleunigen. Dieser Artikel enthält Schritte zur Behandlung von häufig auftretenden Problemen mit Prebuilds.

In diesem Artikel

Weitere Informationen zu GitHub Codespaces-Prebuilds findest du unter AUTOTITLE.

Prüfst du, ob ein Codespace aus einem Prebuild erstellt wurde?

Wenn du einen Codespace erstellst, kannst du den Typ des virtuellen Computers auswählen, den du verwenden möchtest. Wenn ein Prebuild für den VM-Typ verfügbar ist, wird „ Prebuild ready“ daneben angezeigt.

Screenshot einer Liste der verfügbaren Computertypen: 2, 4, 8, 16 und 32 Kerne, alle mit der Bezeichnung „Prebuild bereit“.

Wenn du die Voreinstellungen für den GitHub Codespaces-Editor auf „Visual Studio Code für Web“ festgelegt hast, wird auf der Seite „Einrichten deines Codespace“ die Meldung „Vordefinierter Codespace gefunden“ angezeigt, wenn ein Prebuild verwendet wird.

Screenshot der Seite „Einrichten deines Codespace“ mit dem folgenden Text: „Vordefinierter Codespace gefunden. Image wird heruntergeladen.“

Ähnlich verhält es sich, wenn deine Editor-Voreinstellung „VS Code“ lautet. Dann wird im integrierten Terminal die Meldung „Du befindest dich in einem vordefinierten Codespace, der durch die Prebuildkonfiguration für dein Repository definiert ist“ angezeigt, wenn du einen neuen Codespace erstellst. Weitere Informationen finden Sie unter AUTOTITLE.

Nachdem du einen Codespace erstellt hast, kannst du überprüfen, ob er aus einem Prebuild erstellt wurde, indem du den folgenden GitHub CLI-Befehl im Terminal ausführst:

Shell
gh api /user/codespaces/$CODESPACE_NAME --jq .prebuild

Dieser gibt zurück, wenn der Codespace mithilfe eines Prebuilds erstellt wurde.

Wenn GitHub CLI () nicht installiert ist, kannst du den folgenden Befehl verwenden, der zurückgibt, wenn der Codespace aus einem Prebuild erstellt wurde:

Shell
cat /workspaces/.codespaces/shared/environment-variables.json | jq '.ACTION_NAME'

Die Überprüfung der Prebuild-Verwendung

Du kannst auf der Seite „Codespaces“ der Repositoryeinstellungen überprüfen, ob ein Repository Prebuilds nutzt.

Du kannst überprüfen, wie viel Speicherplatz von Prebuilds im aktuellen Abrechnungszeitraum verbraucht wurde, indem du dir die Abrechnungsdaten für dein persönliches Konto oder Organisationskonto ansiehst. Du kannst auch einen Nutzungsbericht generieren, um zu ermitteln, welche Repositorys Prebuilds verwendet haben. Weitere Informationen finden Sie unter AUTOTITLE.

Die Bezeichnung „Prebuild Ready“ fehlt manchmal.

Wenn du einen neuen Codespace aus einem Branch mit Prebuild-Unterstützung erstellst, stellst du vielleicht fest, dass die Bezeichnung „ Prebuild Ready“ nicht im Dialogfeld zur Auswahl eines Computertyps angezeigt wird. Dies bedeutet, dass Prebuilds derzeit nicht verfügbar sind.

Standardmäßig wird jedes Mal, wenn du einen Push in einen Branch mit aktivierter Prebuild-Funktion ausführst, der Prebuild aktualisiert. Wenn der Push eine Änderung der Konfiguration des Entwicklungscontainers beinhaltet, wird während der Aktualisierung die Bezeichnung „ Prebuild ready“ aus der Liste der Computertypen entfernt. Während dieser Zeit kannst du weiterhin Codespaces ohne Prebuild erstellen. Bei Bedarf kannst du die Anzahl der Fälle reduzieren, in denen Prebuilds für ein Repository nicht verfügbar sind, indem du das Prebuild so einstellst, dass es nur aktualisiert wird, wenn du eine Änderung an deinen Dev-Container-Konfigurationsdateien vornimmst, oder nur nach einem benutzerdefinierten Zeitplan. Weitere Informationen finden Sie unter AUTOTITLE.

Wenn dein Branch nicht speziell für Prebuilds aktiviert ist, kann er trotzdem von Prebuilds profitieren, wenn er von einem Prebuild-aktivierten Branch abgeleitet wurde. Wenn die Dev-Containerkonfiguration jedoch in deinem Branch geändert wird, sodass sie nicht mit der Konfiguration im Basisbranch identisch ist, stehen Prebuilds nicht mehr in deinem Branch zur Verfügung.

Die folgenden Punkte müssen überprüft werden, wenn das Label „ Prebuild Ready“ für einen bestimmten Branch nicht angezeigt wird:

  • Vergewissere dich, dass für diesen Branch eine Prebuildkonfiguration vorhanden ist. Wenn du kein Repositoryadministrator bist, musst du einen solchen bitten, dies zu bestätigen.
  • Vergewissere dich, dass die Vorbuildkonfiguration deine Region enthält.
  • Überprüfe, ob kürzlich eine Änderung der Dev-Containerkonfiguration zu dem Branch mit Prebuildunterstützung verschoben wurde. Wenn dies der Fall ist, musst du in der Regel warten, bis der Prebuild-Workflow für diesen Push abgeschlossen ist, bevor Prebuilds erneut verfügbar sind.
  • Wenn in letzter Zeit keine Konfigurationsänderungen vorgenommen wurden, navigiere zur Registerkarte Actions deines Repositorys, klicke in der Liste der Workflows auf Codespaces Prebuilds, und überprüfe, ob Ausführungen von Prebuildworkflows für den Branch erfolgreich sind. Wenn die letzten Ausführungen eines Workflows erfolglos waren und eine oder mehrere dieser erfolglosen Ausführungen Änderungen an der Dev-Container-Konfiguration enthielten, sind keine Prebuilds für den zugehörigen Branch verfügbar.

In Codespaces, die mithilfe eines Prebuilds erstellt wurden, kann auf einige Ressourcen nicht zugegriffen werden.

Wenn die -Konfigurationsdatei für eine Prebuildkonfiguration angibt, dass Berechtigungen für den Zugriff auf andere Repositorys erforderlich sind, werden Repositoryadministratorinnen beim Erstellen oder Aktualisieren der Prebuildkonfiguration aufgefordert, diese Berechtigungen zu autorisieren. Wenn der bzw. die Administratorin nicht alle angeforderten Berechtigungen gewährt, können im Prebuild und in Codespaces, die aus diesem Prebuild erstellt wurden, unter Umständen Probleme auftreten. Dies gilt auch dann, wenn die Benutzer*innen, die einen Codespace basierend auf diesem Prebuild erstellen, alle Berechtigungen gewähren, wenn sie dazu aufgefordert werden.

Problembehandlung bei erfolglosen Workflowausführungen für Prebuilds

Erhöhen des Ausgabenlimits für GitHub Actions

Prebuilds werden mit GitHub Actions erstellt und aktualisiert. Prebuild-Workflows werden fehlschlagen, wenn du alle deine GitHub Actions-Minuten aufgebraucht hast und dein Ausgabenlimit erreicht ist. Sollte das der Fall sein, kannst du dein Ausgabenlimit für GitHub Actions erhöhen, damit die Workflows ausgeführt werden können. Weitere Informationen finden Sie unter AUTOTITLE.

Autorisieren von Zugriffsberechtigungen

Wenn die -Konfigurationsdatei für eine Prebuildkonfiguration aktualisiert wird, um anzugeben, dass Berechtigungen für den Zugriff auf andere Repositorys erforderlich sind, und Repositoryadministrator*innen nicht zur Autorisierung dieser Berechtigungen für die Prebuildkonfiguration aufgefordert werden, kann der Prebuild fehlschlagen. Versuche, die Prebuildkonfiguration zu aktualisieren, ohne Änderungen vorzunehmen. Wenn du auf Aktualisieren klickst, wird die Autorisierungsseite angezeigt. Überprüfe, ob die angeforderten Berechtigungen geeignet sind, und autorisiere die Anforderung gegebenenfalls. Weitere Informationen findest du unter AUTOTITLE und AUTOTITLE.

Wenn die Workflowausführungen für eine Prebuildkonfiguration erfolglos sind, kannst du die Prebuildkonfiguration vorübergehend deaktivieren, während du Untersuchungen anstellst. Weitere Informationen finden Sie unter AUTOTITLE.

Verhindern der Verwendung veralteter Prebuilds

Wenn beim neuesten Prebuildworkflow ein Fehler aufgetreten ist, wird standardmäßig ein vorheriger Prebuild für die gleiche Kombination aus Repository, Branch und Konfigurationsdatei () verwendet, um neue Codespaces zu erstellen. Dieses Verhalten wird als Prebuild-Optimierung bezeichnet.

Es empfiehlt sich, die Prebuildoptimierung aktiviert zu lassen, da dadurch sichergestellt werden kann, dass weiterhin schnell Codespaces erstellt werden können, auch wenn kein aktueller Prebuild verfügbar ist. Als Repository-Administrator kannst du die Prebuild-Optimierung jedoch deaktivieren, wenn bei dir Probleme mit vordefinierten Codespaces auftreten, die nicht dem aktuellen Zustand der Branches entsprechen. Falls du die Prebuildoptimierung deaktivierst, werden Codespaces für die relevante Kombination aus Repository, Branch und der Datei ohne Prebuild erstellt, wenn beim neuesten Prebuildworkflow ein Fehler aufgetreten ist oder wenn der neueste Prebuildworkflow gerade ausgeführt wird.

  1. Klicke im Abschnitt „Code & automation“ der Randleiste auf Codespaces.

  2. Wählen Sie rechts neben der betroffenen Prebuild-Konfiguration das Dreipunktmenü ( ... ) aus, und klicken Sie anschließend auf Bearbeiten.

    Screenshot der Dropdownliste mit den Prebuildoptionen mit hervorgehobener Option „Bearbeiten“.

  3. Scrolle zum unteren Rand der Seite „Konfiguration bearbeiten“, und klicke auf Erweiterte Optionen anzeigen.

    Bildschirmfoto des unteren Teils der Konfigurationsseite für Prebuilds. Der Link „Erweiterte Optionen anzeigen“ ist dunkelorange umrandet.

  4. Falls Sie die Standardeinstellung wirklich deaktivieren möchten, wählen Sie Prebuild-Optimierung deaktivieren aus.

    Screenshot der Einstellungen „Erweiterte Optionen“. Das Kontrollkästchen „Prebuildoptimierung deaktivieren“ ist aktiviert. Darunter befindet sich die Schaltfläche „Aktualisieren“.

  5. Klicke zum Speichern deiner Änderung auf Aktualisieren.

Weiterführende Lektüre

  • AUTOTITEL
  • AUTOTITEL