Azure Boards Csatlakozás a GitHubra (felhő)

  • Cikk

Azure DevOps Services

A GitHub.com adattárak használatával megtervezheti és nyomon követheti a munkáját a szoftverfejlesztéshez és az Azure Boards-projekthez. Csatlakozás a projektet és az adattárat, hogy a GitHub véglegesítési és lekéréses kérelmei az Azure Boardsban lévő munkaelemeihez kapcsolódjanak.

Megjegyzés:

Az Azure Boards és az Azure DevOps Services támogatja a GitHub.com és a GitHub Enterprise Server-adattárakkal való integrációt. Ha helyszíni Azure DevOps-kiszolgálóról szeretne csatlakozni, tekintse meg Csatlakozás Azure DevOps Server és a GitHub Enterprise Server közötti kapcsolatot.

Előfeltételek

  • Azure Boards- vagy Azure DevOps-projektnek kell lennie. Ha még nem rendelkezik projektel, hozzon létre egyet.
  • A Project Rendszergazda istrators csoport tagjának kell lennie. Ha létrehozta a projektet, rendelkezik engedélyekkel.
  • A GitHub-adattár rendszergazdájának vagy tulajdonosának kell lennie a csatlakozáshoz. Több GitHub-adattárhoz is csatlakozhat, ha Ön rendszergazda az adattárakhoz.

Hitelesítési lehetőségek

A következő hitelesítési lehetőségek támogatottak a csatlakozni kívánt GitHub-platform alapján.

GitHub.com

GitHub Enterprise Server

Megjegyzés:

Ha a GitHubot a PAT-hez csatlakoztatja, győződjön meg arról, hogy konfigurálja az egyszeri bejelentkezést (SSO) a GitHub-fiókjában található PAT-hoz. Erre azért van szükség, hogy lekérhető legyen egy szervezet adattárainak listája, amelyen konfigurálva van a Security Assertion Markup Language (SAML) SSO-hitelesítés.

Csatlakozás Azure Boards-t egy GitHub-adattárba.

  1. Jelentkezzen be az Azure DevOps-projektbe.

  2. Válassza a Projektbeállítások>GitHub-kapcsolatok lehetőséget.

    Screenshot of open Project Settings>GitHub connections.

  3. Ha először hoz létre kapcsolatot a projektből, válassza Csatlakozás GitHub-fiókját a GitHub-fiók hitelesítő adatainak használatához.

    Screenshot of first time connecting with GitHub credentials.

    Ellenkező esetben válassza az Új kapcsolat lehetőséget, és válassza ki a hitelesítési módszert az Új Csatlakozás ion párbeszédpanelen.

    Amikor a GitHub-fiókjával csatlakozik, használja a GitHub-fiók hitelesítő adatait a hitelesítéshez. A PAT használatához lásd : GitHub-kapcsolat hozzáadása PAT használatával. A GitHub Enterprise Serverhez való csatlakozáshoz lásd: Azure DevOps regisztrálása a GitHubon OAuth-alkalmazásként.

GitHub-kapcsolat hozzáadása GitHub-hitelesítő adatokkal

Akár 500 GitHub-adattárat is csatlakoztathat egy Azure Boards-projekthez.

  1. Ha első alkalommal csatlakozik a GitHubhoz az Azure Boardsból, a rendszer arra kéri, hogy jelentkezzen be a GitHub-hitelesítő adataival. Válasszon ki egy fiókot, amelynek Ön az adattár rendszergazdája.

  2. Válassza ki a csatlakozni kívánt GitHub-fiókot vagy -szervezetet. Csak az Ön tulajdonában lévő vagy rendszergazdai jogosultságokkal rendelkező szervezetek szerepelnek a listában.

    Ha egy szervezet összes adattára már csatlakozott az Azure Boardshoz, az alábbi üzenet jelenik meg.

    Screenshot of message where no more repositories exist to connect.

  3. Adja meg a GitHub hitelesítő adatait. Ha engedélyezve van a kéttényezős hitelesítés, adja meg a GitHub által küldött hitelesítési kódot, és válassza az Ellenőrzés lehetőséget. Ellenkező esetben a rendszer automatikusan felismeri a GitHub-szervezetet, mivel a GitHub-fiókját korábban az Azure DevOps Services-fiókjához társították.

Az adattárak kiválasztása

A hitelesítés után kiválaszthatja a csatlakoztatni kívánt adattárakat.

  1. A GitHub-adattárak hozzáadása párbeszédpanel automatikusan megjeleníti és kijelöli az összes olyan GitHub.com adattárat, amelynek Ön a kijelölt szervezet rendszergazdája. Törölje az összes olyan adattár kijelölését, amelyet nem szeretne részt venni az integrációban.

    Screenshot showing GitHub repos.

    Tipp.

    Azt javasoljuk, hogy csak egyetlen Azure DevOps-szervezetben meghatározott projektekhez csatlakoztassa a GitHub-adattárat. Csatlakozás ha ugyanazt a GitHub-adattárat két vagy több Azure DevOps-szervezetben meghatározott projektekhez szeretné használni, az váratlan következményekhez vezethetAB# említés csatolása. További információ: GitHub & Azure Boards-integráció hibaelhárítása.

    Ha az összes adattár már csatlakozik az aktuális vagy más szervezethez, az alábbi üzenet jelenik meg.

    Screenshot of message where no more repositories exist to connect.

  2. Amikor elkészült, válassza a Mentés lehetőséget.

A kapcsolat megerősítése

  1. Tekintse át a megjelenő GitHub-lapot, majd válassza a Jóváhagyás, telepítés és engedélyezés lehetőséget.

    Screenshot showing confirming GitHub repositories.

  2. Adja meg a GitHub-jelszót a megerősítéshez.

  3. Ha elkészült, látnia kell az új kapcsolatot a kijelölt tárházakkal a listában.

Screenshot of list of connected repositories.

A Konfiguráció módosításához vagy a GitHubhoz készült Azure Boards alkalmazás kezeléséhez lásd : Tárház hozzáférésének módosítása az Azure Boardshoz.

GitHub-kapcsolat hozzáadása a PAT használatával

Azt javasoljuk, hogy a GitHub-fiók hitelesítő adataival csatlakozzon a GitHub-adattárhoz. Ha azonban PAT-t kell használnia, kövesse ezeket az eljárásokat.

Tipp.

A GitHub PAT létrehozásakor győződjön meg arról, hogy a következő hatóköröket tartalmazza: repo, read:user, user:email, admin:repo_hook.

  1. Válassza a személyes hozzáférési jogkivonatot.

    Screenshot of New GitHub connection dialog, choosing Personal Access Token.

    GitHub PAT létrehozásához nyissa meg a GitHub Developer Gépház > Személyes hozzáférési jogkivonatokat.

  2. Írja be a PAT-t, és válassza a Csatlakozás.

    Screenshot showing entered PAT.

  3. Válassza ki a projekthez csatlakoztatni kívánt adattárakat a jelen cikk korábbi, Az adattárak kiválasztása című szakaszában ismertetett eljárásokat követve.

  4. Ha először csatlakozik Egy GitHub-fiókhoz vagy -szervezethez az Azure Boardsból, telepítenie kell a GitHubhoz készült Azure Boards alkalmazást is. Erősítse meg a kapcsolatot a cikk korábbi részében.

Az Azure DevOps regisztrálása a GitHubon OAuth-alkalmazásként

Ha az OAuth használatával szeretné csatlakoztatni az Azure DevOpst a GitHub Enterprise Serverhez, először OAuth-alkalmazásként kell regisztrálnia az alkalmazást. További információ: OAuth-alkalmazás létrehozása.

Az Azure DevOps Services regisztrálása

  1. Jelentkezzen be a GitHub Enterprise-kiszolgáló webes portálján.

    Screenshot of sign in for GitHub Enterprise server.

  2. Nyissa meg a Gépház> Developer beállításokat>Oauth Apps>Új OAuth-alkalmazás.

    Screenshot showing sequence for New OAuth App.

  3. Adja meg az alkalmazás regisztrálásához szükséges adatokat.

    A Kezdőlap URL-címéhez adja meg a szervezet szervezeti URL-címét.
    Az engedélyezési visszahívási URL-cím létrehozásához használja az alábbi mintát az URL-cím létrehozásához.

    {Azure DevOps Services Organization URL}/_admin/oauth2/callback

    Például:

    https://dev.azure.com/fabrikam/_admin/oauth2/callback

    Screenshot showing app to register.

  4. Válassza az Alkalmazás regisztrálása lehetőséget.

  5. Megjelenik a regisztrált OAuth-alkalmazás ügyfélazonosítója és titkos ügyfélkódja.

    Screenshot of Client ID and Client Secret for the registered OAuth application.

OAuth-konfiguráció regisztrálása az Azure DevOps Servicesben

  1. Jelentkezzen be az Azure DevOps Services webportálra.

  2. Adja hozzá a GitHub Enterprise Oauth-konfigurációt a szervezethez.

  3. A Szervezeti beállítások területen válassza az Oauth-konfigurációk>hozzáadása Oauth-konfigurációk lehetőséget.

    Screenshot of Open Organization Settings, OAuth configurations.

  4. Adja meg az adatait, majd válassza a Létrehozás lehetőséget.

    OAuth configurations dialog.

Az Azure DevOps Services Csatlakozás a GitHub Enterprise Serverre

Fontos

Az Azure DevOps Services és a GitHub Enterprise Server összekapcsolásához a GitHub Enterprise Servernek megfelelően elérhetőnek kell lennie az internetről. Győződjön meg arról, hogy az Azure DNS fel tudja oldani a GitHub Enterprise Server nevét, és a tűzfal engedélyezi a hozzáférést az Azure Data Center IP-címéről. Az IP-címtartomány meghatározásához tekintse meg a Microsoft Azure Data Center IP-tartományait. Csatlakozási problémák esetén gyakori hibaüzenet a következő:

A távoli név nem oldható fel: "github-enterprise-server.contoso.com"

Ha ezt a hibát tapasztalja, ellenőrizze, hogy a kiszolgáló elérhető-e. További információ: Azure DNS – gyakori kérdések.

  1. Válassza a Projektbeállítások>GitHub-kapcsolatok>GitHub Enterprise Server lehetőséget az első kapcsolathoz.

    First connection, choose GitHub Enterprise Server.

    Vagy az Új GitHub kapcsolati párbeszédpanelen válassza a GitHub Enterprise Server lehetőséget.

    Screenshot of New GitHub connection dialog, choose GitHub Enterprise Server.

  2. Válassza ki a hitelesítési módot.

    Screenshot showing authentication method dialog.

    Csatlakozás az OAuthtal

    Válassza ki az OAuth-konfiguráció regisztrálása az Azure DevOps Servicesben 4. lépésében beállított konfigurációt, majd válassza a Csatlakozás.

    Screenshot of New GitHub Enterprise connection, OAuth connection dialog.

    Csatlakozás személyes hozzáférési jogkivonattal

    Adja meg a GitHub Enterprise-kiszolgáló URL-címét és a kiszolgáló által felismert személyes hozzáférési jogkivonat hitelesítő adatait. Ezután válassza a Csatlakozás.

    Screenshot of New GitHub Enterprise connection, Personal access token connection dialog.

    Csatlakozás felhasználónévvel és jelszóval

    Adja meg a GitHub Enterprise-kiszolgáló URL-címét és a kiszolgáló által felismert rendszergazdai fiók hitelesítő adatait, majd válassza a Csatlakozás.

    Screenshot of New GitHub Enterprise connection screen, User Name connection dialog.

  3. A párbeszédpanel felsorolja azokat az adattárakat, amelyekhez a GitHub felügyeleti jogosultságai vannak. Az Enyém és az Összes között váltva megállapíthatja, hogy mások megjelennek-e, majd ellenőrizheti a hozzáadni kívánt elemeket. Ha végzett, válassza a Mentés lehetőséget.

    Screenshot of repositories listed.

    Tipp.

    Csak egy GitHub-szervezet által definiált adattárakkal létesíthet kapcsolatot. Ha egy projektet egy másik GitHub-szervezetben definiált más adattárakhoz szeretne csatlakoztatni, egy másik kapcsolatot kell hozzáadnia.

  4. Ha először csatlakozik Egy GitHub-fiókhoz vagy -szervezethez az Azure Boardsból, akkor az Azure Boards alkalmazást is telepítenie kell a GitHubhoz. Erősítse meg a kapcsolatot a cikk korábbi részében.

Kapcsolódási problémák elhárítása

Az Azure Boards-GitHub integrációja különböző hitelesítési protokollokra támaszkodik a kapcsolat támogatásához. A felhasználó engedélytartományának vagy hitelesítési hitelesítő adatainak módosítása az Azure Boardshoz csatlakoztatott GitHub-adattárak visszavonását okozhatja.

A GitHubhoz készült Azure Boards alkalmazás által támogatott integráció áttekintéséért tekintse meg az Azure Boards-GitHub-integrációt.

Támogatott hitelesítési lehetőségek

A következő hitelesítési lehetőségek támogatottak a csatlakozni kívánt GitHub-platform alapján.

Platform

GitHub.com

GitHub Enterprise Server

Azure DevOps Services

  • GitHub.com felhasználói fiók
  • Személyes hozzáférési jogkivonat (PAT)
  • OAuth
  • PAT
  • Felhasználónév és jelszó

Azure DevOps Server 2020

Nem alkalmazható

  • PAT
  • Felhasználónév és jelszó

Azure DevOps Server 2019

Nem alkalmazható

  • OAuth
  • PAT
  • Felhasználónév és jelszó

Megjegyzés:

A GitHubhoz készült Azure Boards alkalmazással az Azure Boards és az Azure DevOps Services támogatja a GitHub.com és a GitHub Enterprise Server-adattárakkal való integrációt. Az Azure DevOps Servers 2019 és újabb verziói csak a GitHub Enterprise Server-adattárakkal való integrációt támogatják. Más Git-adattárakkal való integráció nem támogatott.

Azure Boards-szervezet hozzáférésének biztosítása

Ha az Azure Boards és a GitHub integrációja nem a várt módon működik, ellenőrizze, hogy rendelkezik-e szervezeti hozzáféréssel.

  1. A GitHub webportálon nyissa meg a Gépház a profil menüjéből.
    Screenshot of open profile, choose Settings.

  2. Az Integrations Authorized OAuth Apps>Azure Boards>alatt válassza ki az alkalmazásokat.

  3. A Szervezeti hozzáférés csoportban oldja meg az esetlegesen megjelenő problémákat. Válassza a Grant lehetőséget, ha hozzáférést szeretne adni minden olyan szervezetnek, amely függőben lévő hozzáférési kérelemként jelenik meg.

    Screenshot of Organization access with organizations without access.

Hozzáférési problémák megoldása

Ha az Azure Boards GitHubhoz való kapcsolata már nem rendelkezik hozzáféréssel, a riasztás állapota piros X-sel jelenik meg a felhasználói felületen. Vigye az egérmutatót a riasztás fölé, és azt jelzi, hogy a hitelesítő adatok már nem érvényesek. A probléma megoldásához távolítsa el a kapcsolatot, és hozza létre újra az új kapcsolatot.

Screenshot of failed connection.

A probléma megoldásához vegye figyelembe a következő elemeket:

  • Ha a kapcsolat OAuth-ot használ:

    • Az Azure Boards-alkalmazás hozzáférése megtagadva volt az egyik adattárhoz.

    • Előfordulhat, hogy a GitHub nem érhető el/nem érhető el. Ennek az elérhetetlenségnek az lehet az oka, hogy szolgáltatáskimaradás vagy infrastruktúra-/hálózati probléma a helyszínen. A szolgáltatás állapotát az alábbi hivatkozásokon ellenőrizheti:

      Törölje és hozza létre újra a kapcsolatot a GitHub-adattárral. Ez az újra létrehozott kapcsolat miatt a GitHub kérni fogja az Azure Boards újbóli hitelesítését.

  • Ha a kapcsolat PAT-t használ:

    • Előfordulhat, hogy a PAT-t visszavonták, vagy a szükséges engedély hatókörei megváltoztak, és nem elegendőek.

    • Előfordulhat, hogy a felhasználó nem rendelkezik rendszergazdai engedélyekkel a GitHub-adattárban.

      Hozza létre újra a PAT-t, és győződjön meg arról, hogy a jogkivonat hatóköre tartalmazza a szükséges engedélyeket: repo, read:user, user:email, admin:repo_hook.

Megszakadt GitHub Enterprise Server-kapcsolat feloldása

Ha már meglévő GitHub Enterprise Server-kapcsolattal migrált az Azure DevOps Serverről az Azure DevOps Services szolgáltatásba, a meglévő kapcsolat nem a várt módon fog működni. Előfordulhat, hogy a GitHubon lévő munkaelemek említése késleltetve vagy soha nem jelenik meg az Azure DevOps Servicesben. Ez a probléma azért fordul elő, mert a GitHubhoz társított visszahívási URL-cím már nem érvényes.

Vegye figyelembe a következő megoldásokat:

  • Távolítsa el és hozza létre újra a kapcsolatot: Távolítsa el és hozza létre újra a kapcsolatot a GitHub Enterprise Server-adattárral. Kövesse az Azure Boards dokumentációjában Csatlakozás lépéseinek sorrendjét.

  • A webhook URL-címének javítása: Nyissa meg a GitHub adattárbeállítási lapját, és szerkessze a webhook URL-címét, és mutasson a migrált Azure DevOps Services-szervezet URL-címére: https://dev.azure.com/{OrganizationName}/_apis/work/events?api-version=5.2-preview

Csatlakozás több Azure DevOps-szervezetnek

Ha a GitHub-adattárat két vagy több, egynél több Azure DevOps-szervezetben definiált projekthez csatlakoztatja, például dev.azure.com/Contoso és dev.azure.com/Fabrikam, váratlan eredményekhez juthat, amikor AB# -említésekkel hivatkozik a munkaelemekre. Ez a probléma azért fordul elő, mert a munkaelem-azonosítók nem egyediek az Azure DevOps-szervezetekben, így az AB#12 hivatkozhat a Contoso vagy a Fabrikam szervezet egyik munkaelemére. Ha tehát egy munkaelem szerepel egy véglegesítési üzenetben vagy lekéréses kérelemben, mindkét szervezet egy megfelelő azonosítóval rendelkező munkaelemre mutató hivatkozást próbál létrehozni (ha van ilyen).

A felhasználó általában egy AB#-említést tervez, amely egyetlen munkaelemre hivatkozik az egyik projektben. Ha azonban egy azonos azonosítójú munkaelem mindkét fiókban létezik, akkor a hivatkozások mindkét munkaelemhez létrejönnek, ami valószínűleg zavart okoz.

Jelenleg nem lehet megkerülni ezt a problémát, ezért azt javasoljuk, hogy egyetlen GitHub-adattárat csak egyetlen Azure DevOps-szervezethez csatlakoztassa.

Megjegyzés:

Amikor a GitHubhoz készült Azure Boards alkalmazással létesít kapcsolatot, az alkalmazás megakadályozza, hogy két különböző szervezethez csatlakozzon. Ha egy GitHub-adattár helytelenül kapcsolódik a nem megfelelő Azure DevOps-szervezethez, a kapcsolat eltávolításához kapcsolatba kell lépnie a szervezet tulajdonosával, mielőtt hozzáadhatja az adattárat a megfelelő Azure DevOps-szervezethez.

Xml-definíciók frissítése munkaelem-típusok kiválasztásához

Ha a szervezet a üzemeltetett XML- vagy helyszíni XML-folyamatmodellt használja a munkakövetési felület testreszabásához, és a GitHub-hivatkozástípusokat a munkaelem-űrlapok Fejlesztési szakaszában szeretné megtekinteni, frissítenie kell a munkaelem-típusok XML-definícióit.

Ha például felhasználói történeteket és hibákat szeretne csatolni a GitHub véglegesítési és lekérési kérelmeihez a Fejlesztési szakaszból, frissítenie kell a felhasználói történetek és hibák XML-definícióit.

Kövesse az üzemeltetett XML-folyamatmodellben megadott feladatok sorrendjét az XML-definíciók frissítéséhez. Minden munkaelemtípushoz keresse meg a Group Label="Development" szakaszt, és adja hozzá a következő két sort a következő kódszintaxishoz a külső hivatkozástípusok támogatásához: GitHub Commit és GitHub Pull Request.

             <ExternalLinkFilter Type="GitHub Pull Request" />  
             <ExternalLinkFilter Type="GitHub Commit" />

A frissítéskor a szakasznak a következőképpen kell megjelennie.

<Group Label="Development">  
   <Control Type="LinksControl" Name="Development">  
      <LinksControlOptions ViewMode="Dynamic" ZeroDataExperience="Development" ShowCallToAction="true">  
         <ListViewOptions GroupLinks="false">   
         </ListViewOptions>  
         <LinkFilters>  
             <ExternalLinkFilter Type="Build" />  
             <ExternalLinkFilter Type="Integrated in build" />  
             <ExternalLinkFilter Type="Pull Request" />  
             <ExternalLinkFilter Type="Branch" />  
             <ExternalLinkFilter Type="Fixed in Commit" />  
             <ExternalLinkFilter Type="Fixed in Changeset" />  
             <ExternalLinkFilter Type="Source Code File" />  
             <ExternalLinkFilter Type="Found in build" />  
             <ExternalLinkFilter Type="GitHub Pull Request" />  
             <ExternalLinkFilter Type="GitHub Commit" />  
         </LinkFilters>  
      </LinksControlOptions>  
   </Control>  
</Group>

További lépések

GitHub-véglegesítések és lekéréses kérelmek csatolása munkaelemekhez