DokumentationCommerceHandbuch zu Commerce mit Cloud Infrastructure

GitHub-Integration

Last update: Tue Sep 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin
  • Entwickler

Mit der GitHub-Integration können Sie Ihre Adobe Commerce in Cloud-Infrastrukturumgebungen direkt über Ihr GitHub-Repository verwalten. Die Integration verwaltet Inhalte, die bereits in GitHub enthalten sind, und synchronisiert sie mit Ihrem Adobe Commerce im Code-Repository der Cloud-Infrastruktur. Im Wesentlichen wird das Code-Repository zum Spiegel des GitHub-Repositorys.

NOTE
Adobe empfiehlt dringend die Verwendung eines privaten Repositorys für Ihr Adobe Commerce-Projekt in der Cloud-Infrastruktur, um geschützte Informationen oder Entwicklungsarbeiten wie Erweiterungen und vertrauliche Konfigurationen zu schützen.

Diese Integration ermöglicht Ihnen Folgendes:

  • Erstellen einer Umgebung beim Erstellen einer Verzweigung
  • Bereitstellung der Umgebung beim Zusammenführen einer Pull-Anforderung
  • Löschen Sie die Umgebung, wenn Sie die Verzweigung löschen

Sie müssen ein GitHub-Token und einen Webhook abrufen, um den Prozess fortzusetzen.

Voraussetzungen

  • Administratorzugriff auf das Adobe Commerce-Projekt in der Cloud-Infrastruktur
  • GitHub-Repository
  • GitHub-Token für den persönlichen Zugriff

GitHub-Token generieren

Erstellen Sie ein klassisches persönliches Zugriffstoken in den GitHub-Entwicklereinstellungen. Sie müssen Mitglied einer Gruppe mit Schreibzugriff auf das GitHub-Repository sein, damit Sie Push an das Repository senden können. Schließen Sie beim Erstellen Ihres Tokens die folgenden Bereiche ein:

  • admin:repo_hook - Erstellen von Web-Hooks
  • repo—Integration in Ihr Repository
  • read:org—Integrieren Sie in Ihr Organisations-Repository.

Siehe GitHub: Erstellen.

Repository vorbereiten

Klonen Sie Ihr Adobe Commerce-Projekt in der Cloud-Infrastruktur von einer bestehenden Umgebung und migrieren Sie die Projektverzweigungen in ein neues, leeres GitHub-Repository, wobei Sie dieselben Zweignamen beibehalten. Es ist wichtig, eine identische Git-Struktur beizubehalten, damit Sie keine bestehenden Umgebungen oder Verzweigungen in Ihrer Adobe Commerce im Cloud-Infrastrukturprojekt verlieren.

  1. Melden Sie sich über das Terminal bei Ihrem Adobe Commerce-Projekt für eine Cloud-Infrastruktur an.

    code language-bash 
    magento-cloud login

  2. Geben Sie Ihre Projekte an und kopieren Sie die Projekt-ID.

    code language-bash 
    magento-cloud project:list

  3. Klonen Sie das Projekt in Ihrer lokalen Umgebung.

    code language-bash 
    magento-cloud project:get <project-ID>

  4. Fügen Sie Ihr GitHub-Repository als Remote-Repository hinzu.

    code language-bash 
    git remote add origin git@github.com:<user-name>/<repo-name>.git

    Der Standardname für die Remote-Verbindung kann origin oder magento sein. Wenn origin vorhanden ist, können Sie einen anderen Namen wählen oder die vorhandene Referenz umbenennen oder löschen. Siehe git-remote-Dokumentation.

  5. Stellen Sie sicher, dass Sie die GitHub-Fernbedienung korrekt hinzugefügt haben.

    code language-bash 
    git remote -v

    Erwartete Antwort:

    code language-none 
    origin git@github.com:<user-name>/<repo-name>.git (fetch)
origin git@github.com:<user-name>/<repo-name>.git (push)

  6. Schicken Sie die Projektdateien an Ihr neues GitHub-Repository. Denken Sie daran, alle Zweignamen gleich zu halten.

    code language-bash 
    git push -u origin master

    Wenn Sie mit einem neuen GitHub-Repository beginnen, müssen Sie möglicherweise die Option -f verwenden, da das Remote-Repository nicht mit Ihrer lokalen Kopie übereinstimmt.

  7. Stellen Sie sicher, dass Ihr GitHub-Repository alle Ihre Projektdateien enthält.

GitHub-Integration aktivieren

Bevor Sie beginnen, müssen sich Ihr Projektcode und Ihre Umgebungen im GitHub-Repository befinden. Nach Aktivierung der Integration wird das GitHub-Repository zur Codequelle. Wenn Sie Code-Änderungen an das ursprüngliche magento-Repository pushen, wird dieser von der Integration überschrieben, wenn Sie Code-Änderungen an Ihr GitHub-Repository pushen.

Im Folgenden wird die GitHub-Integration aktiviert und eine Payload-URL bereitgestellt, die beim Erstellen eines Webhooks verwendet werden kann.

WARNING
Der folgende Befehl überschreibt den Code all in Ihrem Adobe Commerce-Projekt in der Cloud-Infrastruktur mit Code aus Ihrem GitHub-Repository, der alle Verzweigungen einschließlich der Verzweigung production enthält. Diese Aktion erfolgt sofort und kann nicht rückgängig gemacht werden. Als Best Practice ist es wichtig, alle Verzweigungen aus Ihrem Adobe Commerce im Cloud-Infrastrukturprojekt zu klonen und sie in Ihr GitHub-Repository zu übertragen, bevor die GitHub-Integration hinzufügt.

Sie können die CLI-Aufforderungen mit magento-cloud integration:add schrittweise ausführen oder den Integrationsbefehl mit den folgenden Optionen erstellen:

Option
Erforderlich?
Beschreibung
--base-url
Ja
Die Basis-URL der Serverinstallation, die https://github.com/ oder ein benutzerdefinierter Wert sein kann. Lassen Sie diese Option weg, wenn Ihr Repository mit öffentlichem GitHub gehostet wird oder wenn Ihr Repository nicht auf privaten Servern gehostet wird. Lassen Sie diese Option weg, wenn Ihre Repository-URL https://github.com/{account}/{repository-name} ähnelt. Dies kann Fehler wie Unable to connect to GitHub: repository not found verursachen.
--token
Ja
Das persönliche Zugriffstoken, das Sie für GitHub generiert haben
--repository
Ja
Der Repository-Name: owner-or-organisation/repository
--build-pull-requests
Optional
Weist Adobe Commerce in der Cloud-Infrastruktur nach dem Zusammenführen einer Pull-Anforderung (true standardmäßig) die Bereitstellung an
--fetch-branches
Optional
Verursacht, dass Adobe Commerce in der Cloud-Infrastruktur Verzweigungen verfolgt und bereitstellt, nachdem Sie eine Verzweigung aktualisiert haben (true standardmäßig)
--prune-branches
Optional
Löschen Sie Zweige, die nicht auf der Remote-Site vorhanden sind (true standardmäßig)

Es gibt viele weitere Optionen, die Sie mithilfe der Hilfeoption sehen können:

magento-cloud integration:add --help

Aktivieren der GitHub-Integration:

  1. Aktivieren Sie die Integration.

    code language-bash 
    magento-cloud integration:add --type=github --project=<project-ID> --token=<your-GitHub-token> {--repository=USER/REPOSITORY | --repository=ORGANIZATION/REPOSITORY} [--build-pull-requests={true|false} --fetch-branches={true|false}

    Beispiel 1: Aktivieren Sie die GitHub-Integration für ein persönliches, privates Repository:

    code language-bash 
    magento-cloud integration:add --type=github --project=ov58dlacU2e --base-url=https://github.com --token=<token> --repository=myUserName/myrepo

    Beispiel 2: Aktivieren Sie die GitHub-Integration für ein Organisations-Repository:

    code language-bash 
    magento-cloud integration:add --type=github --project=ov58dlacU2e --base-url=https://github.com --token=<token> --repository=Magento/teamrepo

  2. Geben Sie bei Aufforderung die erforderlichen Informationen ein.

  3. Kopieren Sie die Payload-URL, die von der Ausgabe der Ausgabe angezeigt wird.

    code language-none 
    Created integration <integration-ID> (type: github)
Repository: myUserName/myrepo
Build PRs: yes
Fetch branches: yes
Payload URL: https://us.magento.cloud/api/projects/<project-id>/integrations/wO8a0eoamxwcg/hook

Webhook in GitHub hinzufügen

Um Ereignisse wie Push-Benachrichtigungen mit Ihrem Cloud Git-Server zu kommunizieren, müssen Sie einen Webhook für Ihr GitHub-Repository erstellen:

  1. Klicken Sie in Ihrem GitHub-Repository auf die Registerkarte Einstellungen .

  2. Klicken Sie in der linken Navigationsleiste auf Webhooks.

  3. Klicken Sie im Bereich Webhooks auf Webhook hinzufügen.

  4. Bearbeiten Sie im Formular Webhooks/Add webhook die folgenden Felder:

    • Payload-URL: Geben Sie die URL ein, die zurückgegeben wird, wenn Sie die GitHub-Integration aktiviert haben.
    • Content type: Wählen Sie application/json aus der Liste aus.
    • Geheimnis: Geben Sie ein Verifizierungsgeheimnis ein.
    • Welche Ereignisse möchten Sie auf diesen Webhook Trigger haben?: Wählen Sie Alles senden aus.
    • Aktivieren Sie das Kontrollkästchen Aktiv .

  5. Klicken Sie auf Webhook hinzufügen.

Integration testen

Nach der Konfiguration der GitHub-Integration können Sie mithilfe der magento-cloud-CLI überprüfen, ob die Integration funktioniert:

magento-cloud integration:validate

Alternativ können Sie sie testen, indem Sie eine einfache Änderung an Ihr GitHub-Repository senden.

  1. Erstellen Sie eine Testdatei.

    code language-bash 
    touch test.md

  2. Übertragen Sie die Änderung und übertragen Sie sie in Ihr GitHub-Repository.

    code language-bash 
    git add . && git commit -m "Testing GitHub integration" && git push

  3. Melden Sie sich bei Cloud Console an und überprüfen Sie, ob Ihre Commit-Nachricht angezeigt wird und Ihr Projekt bereitgestellt wird.

Integration entfernen

Sie können die GitHub-Integration sicher aus Ihrem Projekt entfernen, ohne den Code zu beeinträchtigen.

Entfernen der GitHub-Integration:

  1. Melden Sie sich über das Terminal bei Ihrem Adobe Commerce-Projekt für eine Cloud-Infrastruktur an.

  2. Geben Sie Ihre Integrationen an. Sie benötigen die GitHub-Integrations-ID, um den nächsten Schritt abzuschließen.

    code language-bash 
    magento-cloud integration:list

  3. Löschen Sie die Integration.

    code language-bash 
    magento-cloud integration:delete <int-ID>

Außerdem können Sie die GitHub-Integration entfernen, indem Sie sich bei Ihrem GitHub-Konto anmelden und den Web-Hook auf der Registerkarte Webhooks des Repositorys entfernen Einstellungen.

recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26