Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren

Informationen zu Veröffentlichungsquellen

Du kannst deine Website veröffentlichen, wenn Änderungen an einen bestimmten Branch gepusht werden, oder du kannst einen GitHub Actions-Workflow schreiben, um deine Website zu veröffentlichen.

Wenn du keine Kontrolle über den Buildprozess für deine Website benötigst, wird empfohlen, deine Website zu veröffentlichen, wenn Änderungen an einen bestimmten Branch gepusht werden. Du kannst angeben, welcher Branch und welcher Ordner als Veröffentlichungsquelle verwendet werden sollen. Der Quellbranch kann ein beliebiger Branch in deinem Repository sein, und der Quellordner kann entweder der Stamm des Repositorys (/) im Quellbranch oder der Ordner /docs im Quellbranch sein. Wenn Änderungen an den Quellbranch gepusht werden, werden die Änderungen im Quellordner in deiner GitHub Pages-Website veröffentlicht.

Wenn du einen anderen Buildprozess als Jekyll verwenden möchtest oder nicht möchtest, dass deine kompilierten statischen Dateien in einem dedizierten Branch enthalten sind, wird empfohlen, einen GitHub Actions-Workflow zu schreiben, um deine Website zu veröffentlichen. GitHub bietet Workflowvorlagen für häufiger vorkommende Veröffentlichungsszenarien, die Ihnen beim Schreiben von Workflows helfen.

Veröffentlichen aus einem Branch

1. Stelle sicher, dass der Branch, den du als Veröffentlichungsquelle nutzen möchtest, bereits in deinem Repository vorhanden ist.

2. Navigiere in GitHub zum Repository Deiner Website.

3. Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

   

4. Klicke im Abschnitt „Code und Automatisierung“ der Seitenleiste auf Seiten.

5. Wähle unter „Erstellen und Bereitstellen“ unter „Quelle“ die Option Aus einem Branch bereitstellen aus.

6. Wähle unter „Build & Deployment“ im Dropdownmenü für Branches eine Veröffentlichungsquelle aus.

   

7. Verwende wahlweise das Dropdownmenü für Ordner, um einen Ordner für deine Veröffentlichungsquelle auszuwählen.

   

8. Klicke auf Speichern.

Problembehandlung beim Veröffentlichen aus einem Branch

Wenn du den docs-Ordner in jedem Branch als Veröffentlichungsquelle auswählst und später den /docs-Ordner aus diesem Branch in deinem Repository entfernst, wird deine Website nicht erstellt, und du erhältst eine Seiten-Buildfehlermeldung aufgrund eines fehlenden /docs-Ordners. Weitere Informationen finden Sie unter Fehlerbehebung bei Jekyll-Build-Fehlern für GitHub Pages-Websites.

Deine GitHub Pages-Website wird immer mit einer GitHub Actions-Workflowausführung bereitgestellt, selbst wenn du deine GitHub Pages-Website so konfigurierst, dass sie mit einem anderen CI-Tool erstellt wird. Die meisten externen CI-Workflows werden in GitHub Pages „bereitgestellt“, indem die Buildausgabe im gh-pages-Branch des Repositorys committet wird, und schließen in der Regel eine .nojekyll-Datei ein. Wenn dies geschieht, erkennt der GitHub Actions-Workflow, dass der Branch keinen Build-Schritt benötigt, und führt nur die Schritte aus, die erforderlich sind, um die Website auf GitHub Pages-Servern bereitzustellen.

Um potenzielle Fehler bei der Erstellung oder der Bereitstellung zu finden, kannst du die Ausführung des Workflows für deine GitHub Pages-Website kontrollieren, indem du die Workflowausführungen deines Repositorys überprüfst. Weitere Informationen finden Sie unter Anzeigen des Ausführungsverlaufs eines Workflows. Weitere Informationen zum erneuten Ausführen des Workflows im Falle eines Fehlers findest du unter Erneutes Ausführen von Workflows und Jobs.

Veröffentlichen mit einem benutzerdefinierten GitHub Actions-Workflow

So konfigurierst du deine Website für das Veröffentlichen mit GitHub Actions:

1. Navigiere in GitHub zum Repository Deiner Website.

2. Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

   

3. Klicke im Abschnitt „Code und Automatisierung“ der Seitenleiste auf Seiten.

4. Wähle unter „Build & Deployment“ unter „Quelle“ GitHub Actions aus.

5. GitHub schlägt mehrere Workflowvorlagen vor. Wenn du bereits über einen Workflow zum Veröffentlichen deiner Website verfügst, kannst du diesen Schritt überspringen. Anderenfalls wähle eine der Optionen aus, um einen GitHub Actions-Workflow zu erstellen. Weitere Informationen zum Erstellen deines benutzerdefinierten Workflows findest du unter Erstellen eines benutzerdefinierten GitHub Actions-Workflows zum Veröffentlichen deiner Website.

   Den GitHub Pages-Einstellungen wird von den GitHub Pages kein bestimmter Workflow zugeordnet. Die GitHub Pages-Einstellungen werden jedoch mit der Workflowausführung verknüpft, von der deine Website zuletzt bereitgestellt wurde.

Erstellen eines benutzerdefinierten GitHub Actions-Workflows zum Veröffentlichen deiner Website

Weitere Informationen zu GitHub Actions findest du unter GitHub Actions-Dokumentation.

Wenn Sie die Website so konfigurieren, dass sie mit GitHub Actions veröffentlicht wird, schlägt GitHub Workflowvorlagen für häufiger vorkommende Veröffentlichungsszenarien vor. Der allgemeine Ablauf eines Workflows umfasst Folgendes:

1. Wird ausgelöst, wenn ein Push in den Standardbranch des Repositorys erfolgt oder wenn der Workflow manuell über die Registerkarte „Aktionen“ ausgeführt wird.
2. Auschecken des Repositoryinhalts mit der Aktion actions/checkout.
3. Erstellen statischer Websitedateien (sofern von der Website verlangt).
4. Hochladen der statischen Datei als Artefakt mit der Aktion actions/upload-pages-artifact.
5. Bereitstellen des Artefakts mit der Aktion actions/deploy-pages, wenn der Workflow durch einen Push an den Standardbranch ausgelöst wurde. Dieser Schritt wird übersprungen, wenn der Workflow durch einen Pull Request ausgelöst wurde.

Die Workflowvorlagen nutzen eine Bereitstellungsumgebung namens github-pages. Wenn dein Repository noch keine Umgebung namens github-pages enthält, wird sie automatisch erstellt. Es wird empfohlen, eine Bereitstellungsschutzregel hinzuzufügen, damit nur der Standardbranch für diese Umgebung bereitgestellt werden kann. Weitere Informationen finden Sie unter Verwalten von Umgebungen für die Bereitstellung.

Problembehandlung beim Veröffentlichen mit einem benutzerdefinierten GitHub Actions-Workflow

Informationen zur Problembehandlung deines GitHub Actions-Workflows findest du unter Überwachungs- und Problembehandlungsworkflows.