DocumentatieCommerceHandleiding Commerce on Cloud Infrastructure

GitHub-integratie

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Beheerder
  • Ontwikkelaar

De integratie GitHub laat u toe om uw Adobe Commerce op de milieu's van de wolkeninfrastructuur direct van uw bewaarplaats te beheren GitHub. De integratie beheert inhoud reeds in GitHub en synchroniseert met uw Adobe Commerce op de bewaarplaats van de code van de wolkeninfrastructuur. In wezen, wordt de codebewaarplaats een spiegel van de bewaarplaats GitHub.

NOTE
Adobe raadt u ten zeerste aan een privéopslagplaats voor uw Adobe Commerce te gebruiken voor een cloudinfrastructuurproject om eigendomsgebonden informatie of ontwikkelingswerk, zoals extensies en kwetsbare configuraties, te beschermen.

Dankzij deze integratie kunt u:

  • Een omgeving maken wanneer u een vertakking maakt
  • Implementeer de omgeving opnieuw wanneer u een pull-verzoek samenvoegt
  • De omgeving verwijderen wanneer u de vertakking verwijdert

U moet een teken GitHub en een webhaak verkrijgen om het proces voort te zetten.

Vereisten

  • Beheerderstoegang tot de Adobe Commerce in het infrastructuurproject voor de cloud
  • GitHub-opslagplaats
  • Het persoonlijke toegangstoken van GitHub

Een GitHub-token genereren

Creeer een klassiek persoonlijk toegangstoken in de ontwikkelaarmontages van GitHub. U moet een lid van een groep met schrijven-toegang tot de bewaarplaats zijn GitHub, zodat u duw aan de bewaarplaats kunt. Neem het volgende bereik op bij het maken van uw token:

  • admin:repo_hook—Webhaken maken
  • repo—Integreren met uw gegevensopslagruimte
  • read:org—Integreer met de opslagplaats van uw organisatie

Zie GitHub: creeer.

De opslagplaats voorbereiden

Clone uw Adobe Commerce op het project van de wolkeninfrastructuur van een bestaand milieu en migreer de projecttakken aan een nieuwe, lege bewaarplaats GitHub, die de zelfde taknamen bewaart. Het is kritiek om een identieke boom van het Git te behouden, zodat u geen bestaande milieu's of takken in uw Adobe Commerce op het project van de wolkeninfrastructuur verliest.

  1. Meld u vanaf de terminal aan bij uw Adobe Commerce voor een infrastructuurproject voor de cloud.

    code language-bash 
    magento-cloud login

  2. Maak een lijst van uw projecten en kopieer projectidentiteitskaart

    code language-bash 
    magento-cloud project:list

  3. Kloont het project naar uw lokale omgeving.

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

  4. Voeg uw bewaarplaats GitHub als ver toe.

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

    De standaardnaam voor de externe verbinding kan origin of magento zijn. Als origin bestaat, kunt u een verschillende naam kiezen of u kunt de bestaande verwijzing een andere naam geven of verwijderen. Zie git-verre documentatie.

  5. Verifieer dat u ver GitHub correct toevoegde.

    code language-bash 
    git remote -v

    Verwacht antwoord:

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

  6. Duw de projectdossiers aan uw nieuwe bewaarplaats GitHub. Vergeet niet alle vertakkingsnamen gelijk te houden.

    code language-bash 
    git push -u origin master

    Als u met een nieuwe bewaarplaats GitHub begint, kunt u de -f optie moeten gebruiken, omdat de verre bewaarplaats niet uw lokale exemplaar aanpast.

  7. Verifieer dat uw bewaarplaats GitHub al uw projectdossiers bevat.

De integratie met GitHub inschakelen

Alvorens u begint, moeten uw projectcode en milieu's in de bewaarplaats zijn GitHub. Na het toelaten van de integratie, wordt de bewaarplaats GitHub de codebron. Als u code verandert in de originele magento bewaarplaats, wordt het overschreven door de integratie wanneer u codeveranderingen in uw bewaarplaats GitHub duwt.

Het volgende laat de integratie GitHub toe en verstrekt een nuttige URL om te gebruiken wanneer het creëren van een webhaak.

WARNING
Het volgende bevel beschrijft alle code in uw Adobe Commerce op het project van de wolkeninfrastructuur met code van uw bewaarplaats GitHub, die alle takken, met inbegrip van de production tak omvat. Deze handeling gebeurt onmiddellijk en kan niet ongedaan worden gemaakt. Als beste praktijken, is het belangrijk om alle takken van uw Adobe Commerce op het project van de wolkeninfrastructuur te klonen en hen te duwen aan uw bewaarplaats GitHub alvorens de integratie GitHub toe te voegen.

U kunt verkiezen om door de CLI herinneringen te stappen gebruikend magento-cloud integration:add of u kunt het integratiebevel met de volgende opties bouwen:

Optie
Vereist?
Beschrijving
--base-url
Ja
De basis-URL van de serverinstallatie, die https://github.com/ of een aangepast item kan zijn. Laat deze optie weg als uw gegevensopslagruimte wordt gehost met openbare Github.
--token
Ja
Het persoonlijke toegangstoken dat u voor GitHub produceerde
--repository
Ja
De naam van de gegevensopslagruimte: owner-or-organisation/repository
--build-pull-requests
Optioneel
Instrueert Adobe Commerce op wolkeninfrastructuur om op te stellen nadat u een trekkrachtverzoek samenvoegt (true door gebrek)
--fetch-branches
Optioneel
Zorgt ervoor dat Adobe Commerce op cloudinfrastructuur vertakkingen bijhoudt en implementeert nadat u een vertakking hebt bijgewerkt (true standaard)
--prune-branches
Optioneel
Vertakkingen verwijderen die niet op de externe server bestaan (true standaard)

Er zijn veel meer opties en u kunt deze weergeven met de optie Help:

magento-cloud integration:add --help

om de integratie GitHub toe te laten:

  1. De integratie inschakelen.

    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}

    Voorbeeld 1: Laat de integratie GitHub voor een persoonlijke, privé bewaarplaats toe:

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

    Voorbeeld 2: Laat de integratie GitHub voor een organisatiebewaarplaats toe:

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

  2. Voer de vereiste informatie in wanneer u hierom wordt gevraagd.

  3. Kopieer Payload URL getoond door de terugkeeroutput.

    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

Webhaak toevoegen in GitHub

Om gebeurtenissen-zulke zoals een duw-met uw server van de it van de Plaats van de Wolk mee te delen, moet u een webhaak voor uw bewaarplaats van GitHub tot stand brengen:

  1. In uw bewaarplaats GitHub, klik de Montages tabel.

  2. In de linkernavigatiebar, klik Webhooks.

  3. In de ruit Webhooks, klik webhaak toevoegen.

  4. In Webhooks/voeg webhaak vorm toe, geef de volgende gebieden uit:

    • Payload URL: Ga URL in teruggekeerd toen u de integratie GitHub toeliet.
    • Type van Inhoud: Kies toepassing/json van de lijst.
    • Geheim: Ga een verificatiegeheim in.
    • Welke gebeurtenissen wilt u deze webhaak teweegbrengen?: Selecteer verzend me alles.
    • Selecteer Actieve checkbox.

  5. Klik toevoegen webhaak.

Integratie testen

Na het vormen van de integratie GitHub, kunt u verifiëren dat de integratie operationeel gebruikend magento-cloud CLI is:

magento-cloud integration:validate

Of u kunt het testen door een eenvoudige verandering in uw bewaarplaats te duwen GitHub.

  1. Maak een testbestand.

    code language-bash 
    touch test.md

  2. Verbind en duw de verandering in uw bewaarplaats GitHub.

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

  3. Meld u aan bij de Cloud Console en controleer of uw commit-bericht wordt weergegeven en of uw project wordt geïmplementeerd.

Integratie verwijderen

U kunt de integratie van GitHub uit uw project veilig verwijderen zonder uw code te beïnvloeden.

om de integratie te verwijderen GitHub:

  1. Meld u vanaf de terminal aan bij uw Adobe Commerce voor een infrastructuurproject voor de cloud.

  2. Maak een lijst van uw integratie. U hebt de integratie-id van GitHub nodig om de volgende stap te voltooien.

    code language-bash 
    magento-cloud integration:list

  3. De integratie verwijderen.

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

Ook, kunt u de integratie verwijderen GitHub door aan uw rekening te registreren GitHub en de Webhaak in Webhooks tabel van de bewaarplaats Montages te verwijderen.

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