Konfigurieren einer Quelle zur Veröffentlichung für Ihre GitHub Pages-Seite

Sie können Ihre GitHub Pages-Website so konfigurieren, dass sie veröffentlicht wird, wenn Änderungen in einen bestimmten Zweig gepusht werden, oder Sie können einen GitHub Actions-Workflow schreiben, um Ihre Website zu veröffentlichen.

Wer kann dieses Feature verwenden?

People with admin or maintainer permissions for a repository can configure a publishing source for a GitHub Pages site.

GitHub Pages ist in öffentlichen Repositorys mit GitHub Free und GitHub Free für Organisationen sowie in öffentlichen und privaten Repositorys mit GitHub Pro, GitHub Team, GitHub Enterprise Cloud und GitHub Enterprise Server verfügbar.

In diesem Artikel

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. Um GitHub Actions als Veröffentlichungsquelle für GitHub Pages zu verwenden, muss ein Siteadministrator GitHub Actions für GitHub Enterprise Server aktivieren. Weitere Informationen findest du unter Aktivieren von GitHub Actions für GitHub Enterprise Server.

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 gängige Veröffentlichungsszenarios, die dir beim Schreiben von Workflows helfen.

Warnung

Wenn dein Websiteadministrator öffentliche Seiten aktiviert hat, sind GitHub Pages-Websites öffentlich im Internet verfügbar, auch wenn das zugehörige Repository privat oder intern ist. Wenn das Repository deiner Website vertrauliche Daten enthält, solltest Du diese vor der Veröffentlichung entfernen. Weitere Informationen findest du unter Konfigurieren von GitHub Seiten für Ihr Unternehmen und Informationen zu Repositorys.

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 auf GitHub zum Repository deiner Website.

  3. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  4. Klicke im Abschnitt „Code and automation“ der Randleiste auf Pages.

  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. Screenshot der Pages-Einstellungen in einem GitHub-Repository. Ein Menü zum Auswählen eines Branchs für eine Veröffentlichungsquelle mit der Bezeichnung „Keine“ ist in dunklem Orange eingerahmt.

  7. Verwende wahlweise das Dropdownmenü für Ordner, um einen Ordner für deine Veröffentlichungsquelle auszuwählen. Screenshot der Pages-Einstellungen in einem GitHub-Repository. Ein Menü zum Auswählen eines Ordners für eine Veröffentlichungsquelle mit der Bezeichnung „/(root)“ ist in dunklem Orange eingerahmt.

  8. Klicke auf Speichern.

Fehlerbehebung beim Veröffentlichen aus einem Zweig

Hinweis

If your repository contains symbolic links, you will need to publish your site using a GitHub Actions workflow. For more information about GitHub Actions, see GitHub Actions-Dokumentation.

Hinweis

  • Wenn du die Veröffentlichung über einen Branch durchführst und deine Website nicht automatisch veröffentlicht wurde, stelle sicher, dass jemand mit Adminberechtigungen und einer verifizierten E-Mail-Adresse einen Push an die Veröffentlichungsquelle durchgeführt hat.
  • Commits, die von einem GitHub Actions-Workflow gepusht werden, der das GITHUB_TOKEN verwendet, lösen keinen GitHub Pages-Build aus.

Wenn du einen Ordner in einem beliebigen Branch als Veröffentlichungsquelle auswählst und den Ordner später aus diesem Branch in deinem Repository entfernst, wird deine Website nicht mehr erstellt, und du erhältst eine Fehlermeldung zum Seitenaufbau aufgrund eines fehlenden Ordners. Weitere Informationen finden Sie unter AUTOTITLE.

Veröffentlichen mit einem benutzerdefinierten GitHub Actions-Workflow

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

  1. Navigiere auf GitHub zum Repository deiner Website.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke im Abschnitt „Code and automation“ der Randleiste auf Pages.

  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.

    Die GitHub Pages ordnen den GitHub Pages-Einstellungen keinen bestimmten Workflow zu. 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 AUTOTITLE.

Wenn du deine Website für die Veröffentlichung mit GitHub Actions konfigurierst, schlägt GitHub Workflowvorlagen für allgemeine Veröffentlichungsszenarios 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 .
  3. Erstellen Sie alle statischen Websitedateien, sofern dies von Ihrer Website verlangt wird.
  4. Verwenden Sie die Aktion, um die statischen Dateien als Artefakt hochzuladen.
  5. Bereitstellen des Artefakts mit der Aktion , 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 . Wenn Ihr Repository noch keine Umgebung namens [] 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 AUTOTITLE.

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

Informationen zur Problembehandlung deines GitHub Actions-Workflows findest du unter AUTOTITLE.