Připojení Azure Boards do GitHubu (cloud)

Služby Azure DevOps

K plánování a sledování práce použijte úložiště GitHub.com pro vývoj softwaru a projekt Azure Boards. Připojení projektu a úložiště, aby se vaše potvrzení GitHubu a žádosti o přijetí změn propojily s vašimi pracovními položkami v Azure Boards.

Poznámka:

Azure Boards a Azure DevOps Services podporují integraci s úložišti GitHub.com a GitHub Enterprise Serverem. Pokud se chcete připojit z místního Azure DevOps Serveru, přečtěte si téma Připojení Azure DevOps Server k GitHub Enterprise Serveru.

Požadavky

  • Musíte mít projekt Azure Boards nebo Azure DevOps. Pokud projekt ještě nemáte, vytvořte ho.
  • Musíte být členem skupiny Project Správa istrators. Pokud jste projekt vytvořili, máte oprávnění.
  • Abyste se mohli připojit, musíte být správcem nebo vlastníkem úložiště GitHub. Pokud jste správcem těchto úložišť, můžete se připojit k více úložištím GitHub.

Možnosti ověřování

Následující možnosti ověřování se podporují na základě platformy GitHubu, ke které se chcete připojit.

GitHub.com

GitHub Enterprise Server

Poznámka:

Pokud se rozhodnete připojit GitHub s patem, ujistěte se, že nakonfigurujete jednotné přihlašování (SSO) pro PAT ve vašem účtu GitHubu. To je potřeba k tomu, aby bylo možné získat seznam úložišť organizace s nakonfigurovaným ověřováním jednotného přihlašování SAML (Security Assertion Markup Language).

Připojení Azure Boards do úložiště GitHub.

  1. Přihlaste se ke svému projektu Azure DevOps.

  2. Vyberte připojení GitHubu v nastavení>projektu.

    Screenshot of open Project Settings>GitHub connections.

  3. Pokud se z projektu poprvé připojíte, zvolte Připojení účtu GitHub a použijte přihlašovací údaje k účtu GitHub.

    Screenshot of first time connecting with GitHub credentials.

    V opačném případě zvolte Nové připojení a v dialogovém okně New Připojení ion vyberte metodu ověřování.

    Když se připojíte pomocí účtu GitHubu, použijte k ověření přihlašovací údaje účtu GitHub. Pokud chcete použít pat, přečtěte si téma Přidání připojení GitHubu pomocí PAT. Pokud se chcete připojit k GitHub Enterprise Serveru, přečtěte si téma Registrace Azure DevOps na GitHubu jako aplikace OAuth.

Přidání připojení GitHubu pomocí přihlašovacích údajů GitHubu

K projektu Azure Boards můžete připojit až 500 úložišť GitHub.

  1. Pokud se z Azure Boards poprvé připojujete k GitHubu, zobrazí se výzva k přihlášení pomocí přihlašovacích údajů GitHubu. Zvolte účet, pro který jste správcem úložiště.

  2. Zvolte účet GitHubu nebo organizaci, ke které se chcete připojit. V seznamu jsou uvedené jenom organizace, které vlastníte nebo které jsou správcem.

    Pokud už jsou všechna úložiště pro organizaci připojená k Azure Boards, zobrazí se následující zpráva.

    Screenshot of message where no more repositories exist to connect.

  3. Zadejte svoje přihlašovací údaje GitHubu. Pokud máte povolené dvoufaktorové ověřování, zadejte ověřovací kód, který vám GitHub poslal, a zvolte Ověřit. Jinak systém automaticky rozpozná vaši organizaci GitHubu, protože váš účet GitHub byl dříve přidružený k vašemu účtu Azure DevOps Services.

Zvolte úložiště.

Po ověření můžete vybrat úložiště, která chcete připojit.

  1. Dialogové okno Přidat úložiště GitHub se automaticky zobrazí a vybere všechna úložiště GitHub.com, pro která jste správcem organizace, kterou jste vybrali. Zrušte výběr všech úložišť, která se nechcete účastnit integrace.

    Screenshot showing GitHub repos.

    Tip

    Doporučujeme připojit úložiště GitHub pouze k projektům definovaným v jedné organizaci Azure DevOps. Připojení stejného úložiště GitHub do projektů definovaných ve dvou nebo více organizacích Azure DevOps může vést k neočekávaným Odkazování na zmínku AB#. Další informace najdete v tématu Řešení potíží s integrací GitHubu a Azure Boards.

    Pokud jsou všechna úložiště již připojená k aktuální nebo jiné organizaci, zobrazí se následující zpráva.

    Screenshot of message where no more repositories exist to connect.

  2. Až budete hotovi, zvolte tlačítko Uložit.

Potvrzení připojení

  1. Zkontrolujte stránku GitHubu, která se zobrazí, a pak zvolte Schválit, Nainstalovat a Autorizovat.

    Screenshot showing confirming GitHub repositories.

  2. Potvrďte heslo GitHubu.

  3. Až budete hotovi, měli byste vidět nové připojení s vybranými úložišti.

Screenshot of list of connected repositories.

Pokud chcete změnit konfiguraci nebo spravovat aplikaci Azure Boards pro GitHub, přečtěte si téma Změna přístupu k úložišti Azure Boards.

Přidání připojení GitHubu pomocí PAT

Pro připojení k úložišti GitHub doporučujeme použít přihlašovací údaje účtu GitHub. Pokud však potřebujete použít pat, postupujte podle těchto postupů.

Tip

Při vytváření pat GitHubu se ujistěte, že zahrnujete tyto obory: repo, read:user, user:email, admin:repo_hook.

  1. Zvolte osobní přístupový token.

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

    Pokud chcete vytvořit pat GitHubu, přejděte na GitHub Developer Nastavení > osobní přístupové tokeny.

  2. Zadejte pat a zvolte Připojení.

    Screenshot showing entered PAT.

  3. Podle postupů popsaných v části Zvolte úložiště , která chcete připojit k projektu, zvolte úložiště, která chcete připojit dříve v tomto článku.

  4. Pokud se z Azure Boards poprvé připojujete k účtu GitHubu nebo organizaci, musíte také nainstalovat aplikaci Azure Boards pro GitHub. Potvrďte připojení dříve v tomto článku.

Registrace Azure DevOps na GitHubu jako aplikace OAuth

Pokud plánujete použít OAuth k připojení Azure DevOps k vašemu GitHub Enterprise Serveru, musíte nejdřív aplikaci zaregistrovat jako aplikaci OAuth. Další informace najdete v tématu Vytvoření aplikace OAuth.

Registrace Azure DevOps Services

  1. Přihlaste se k webovému portálu pro server GitHub Enterprise.

    Screenshot of sign in for GitHub Enterprise server.

  2. Otevřete nastavení Nastavení> Developer>oauth Apps>– nová aplikace OAuth.

    Screenshot showing sequence for New OAuth App.

  3. Zadejte informace pro registraci aplikace.

    Jako adresu URL domovské stránky zadejte adresu URL organizace vaší organizace.
    Pro adresu URL zpětného volání autorizace použijte následující vzor k vytvoření adresy URL.

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

    Příklad:

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

    Screenshot showing app to register.

  4. Vyberte Zaregistrovat aplikaci.

  5. Zobrazí se ID klienta a tajný klíč klienta pro zaregistrovanou aplikaci OAuth.

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

Registrace konfigurace OAuth v Azure DevOps Services

  1. Přihlaste se k webovému portálu pro Azure DevOps Services.

  2. Přidejte do své organizace konfiguraci GitHub Enterprise OAuth.

  3. V nastavení organizace vyberte Konfigurace>Oauth Přidat konfiguraci Oauth.

    Screenshot of Open Organization Settings, OAuth configurations.

  4. Zadejte informace a pak vyberte Vytvořit.

    OAuth configurations dialog.

Připojení Azure DevOps Services na GitHub Enterprise Server

Důležité

Pokud chcete připojit Azure DevOps Services k serveru GitHub Enterprise, musí být gitHub Enterprise Server dostatečně přístupný z internetu. Ujistěte se, že Azure DNS dokáže přeložit název serveru GitHub Enterprise a brána firewall umožňuje přístup z IP adres datacentra Azure. Informace o určení rozsahu IP adres najdete v tématu Rozsahy IP adres datacentra Microsoft Azure. Běžná chybová zpráva, ke které dochází, když existují problémy s připojením:

Vzdálený název nelze přeložit: "github-enterprise-server.contoso.com"

Pokud narazíte na tuto chybu, zkontrolujte, jestli je váš server přístupný. Další informace najdete v nejčastějších dotazech k Azure DNS.

  1. Vyberte nastavení>projektu, ke které gitHub připojí>GitHub Enterprise Server poprvé.

    First connection, choose GitHub Enterprise Server.

    Nebo v dialogovém okně Nové připojení GitHubu vyberte GitHub Enterprise Server.

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

  2. Vyberte metodu ověřování.

    Screenshot showing authentication method dialog.

    Připojení s OAuth

    Zvolte konfiguraci, kterou jste nastavili v kroku 4 registrace konfigurace OAuth v Azure DevOps Services, a pak zvolte Připojení.

    Screenshot of New GitHub Enterprise connection, OAuth connection dialog.

    Připojení s osobním přístupovým tokenem

    Zadejte adresu URL vašeho serveru GitHub Enterprise a přihlašovací údaje tokenu pat, které tento server rozpozná. A pak zvolte Připojení.

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

    Připojení s uživatelským jménem a heslem

    Zadejte adresu URL vašeho serveru GitHub Enterprise a přihlašovací údaje účtu správce rozpoznané tímto serverem a pak vyberte Připojení.

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

  3. V dialogovém okně jsou uvedena všechna úložiště, pro která máte práva pro správu GitHubu. Mezi možnostmi Moje a Vše můžete určit, jestli se zobrazí ostatní, a pak zaškrtnout ty, které chcete přidat. Až budete hotovi, zvolte tlačítko Uložit.

    Screenshot of repositories listed.

    Tip

    Můžete vytvořit připojení jenom k úložištím definovaným v jedné organizaci GitHubu. Pokud chcete připojit projekt k jiným úložištím definovaným v jiné organizaci GitHubu, musíte přidat další připojení.

  4. Pokud se z Azure Boards poprvé připojujete k účtu GitHubu nebo organizaci, nainstalujte si také aplikaci Azure Boards pro GitHub. Potvrďte připojení dříve v tomto článku.

řešení problémů s připojením

Integrace Azure Boards-GitHubu spoléhá na různé ověřovací protokoly pro podporu připojení. Změny oboru oprávnění uživatele nebo přihlašovacích údajů pro ověřování můžou způsobit odvolání úložišť GitHub připojených k Azure Boards.

Přehled integrace, kterou aplikace Azure Boards pro GitHub podporuje, najdete v tématu Integrace Azure Boards-GitHub.

Podporované možnosti ověřování

Následující možnosti ověřování se podporují na základě platformy GitHubu, ke které se chcete připojit.

Platforma

GitHub.com

GitHub Enterprise Server

Služby Azure DevOps

  • GitHub.com uživatelský účet
  • Token PAT (Personal Access Token)
  • OAuth
  • PAT
  • Uživatelské jméno a heslo

Azure DevOps Server 2020

Nelze použít

  • PAT
  • Uživatelské jméno a heslo

Azure DevOps Server 2019

Nelze použít

  • OAuth
  • PAT
  • Uživatelské jméno a heslo

Poznámka:

S aplikací Azure Boards pro GitHub, Azure Boards a Azure DevOps Services podporují integraci s úložišti GitHub.com a GitHub Enterprise Serverem. Azure DevOps Servers 2019 a novější verze podporují integraci pouze s úložišti GitHub Enterprise Serveru. Integrace s jinými úložišti Git se nepodporuje.

Udělení přístupu k organizaci Azure Boards

Pokud integrace mezi Azure Boards a GitHubem nefunguje podle očekávání, ověřte, že máte udělený přístup k organizaci.

  1. Na webovém portálu GitHubu otevřete Nastavení z nabídky profilu.
    Screenshot of open profile, choose Settings.

  2. Vyberte aplikace v části Integrace Autorizované>aplikace OAuth v>Azure Boards.

  3. V části Přístup k organizaci vyřešte všechny problémy, které se můžou zobrazit. Výběrem možnosti Udělit udělte přístup všem organizacím, které se zobrazují jako čekající na vyřízení žádosti o přístup.

    Screenshot of Organization access with organizations without access.

Řešení problémů s přístupem

Když už připojení Azure Boards k GitHubu nemá přístup, zobrazí se v uživatelském rozhraní stav upozornění s červeným X. Najeďte myší na výstrahu a značí, že přihlašovací údaje už nejsou platné. Problém opravíte tak, že odeberete připojení a znovu vytvoříte nové připojení.

Screenshot of failed connection.

Pokud chcete tento problém vyřešit, zvažte následující položky:

  • Pokud připojení používá OAuth:

    • Aplikace Azure Boards měla pro jedno z úložišť odepřený přístup.

    • GitHub může být nedostupný nebo nedostupný. Tato nedostupnost může být způsobená výpadkem služby nebo místního problému s infrastrukturou nebo sítí. Stav služby můžete zkontrolovat na následujících odkazech:

      Odstraňte a znovu vytvořte připojení k úložišti GitHub. Toto znovu vytvořené připojení způsobí, že GitHub zobrazí výzvu k opětovnému ověření Azure Boards.

  • Pokud připojení používá pat:

    • Pat byl pravděpodobně odvolán nebo došlo ke změně požadovaných oborů oprávnění a nejsou dostatečné.

    • Uživatel možná ztratil oprávnění správce v úložišti GitHub.

      Znovu vytvořte token PAT a ujistěte se, že rozsah tokenu zahrnuje požadovaná oprávnění: repo, read:user, user:email, admin:repo_hook.

Řešení nefunkčního připojení k GitHubu Enterprise Serveru

Pokud jste migrovali z Azure DevOps Serveru do Azure DevOps Services s existujícím připojením k GitHub Enterprise Serveru, vaše stávající připojení nebude fungovat podle očekávání. Zmínky o pracovních položkách v GitHubu můžou být zpožděné nebo se v Azure DevOps Services nikdy nezobrazují. K tomuto problému dochází, protože adresa URL zpětného volání přidružená k GitHubu již není platná.

Zvažte následující řešení:

  • Odeberte a znovu vytvořte připojení: Odeberte a znovu vytvořte připojení k úložišti GitHub Enterprise Serveru. Postupujte podle posloupnosti kroků uvedených v Připojení v dokumentaci ke službě Azure Boards.

  • Oprava adresy URL webhooku: Přejděte na stránku nastavení úložiště GitHubu a upravte adresu URL webhooku tak, aby odkazovala na migrovanou adresu URL organizace Azure DevOps Services: https://dev.azure.com/{OrganizationName}/_apis/work/events?api-version=5.2-preview

Připojení do několika organizací Azure DevOps

Pokud připojíte úložiště GitHub k dvěma nebo více projektům definovaným ve více než jedné organizaci Azure DevOps, jako je dev.azure.com/Contoso a dev.azure.com/Fabrikam, může se při použití zmínek AB# zobrazit neočekávané výsledky pro propojení s pracovními položkami. K tomuto problému dochází, protože ID pracovních položek nejsou v organizacích Azure DevOps jedinečná, takže AB#12 může odkazovat na pracovní položku v organizaci Contoso nebo Fabrikam. Takže pokud je pracovní položka zmíněna ve zprávě potvrzení nebo žádosti o přijetí změn, obě organizace se pokusí vytvořit odkaz na pracovní položku s odpovídajícím ID (pokud existuje).

Obecně platí, že uživatel hodlá zmínit ab# odkaz na jednu pracovní položku v jednom z projektů. Pokud ale v obou účtech existuje pracovní položka se stejným ID, vytvoří se propojení pro obě pracovní položky, což pravděpodobně způsobí nejasnost.

V současné době neexistuje způsob, jak tento problém obejít, proto doporučujeme připojit jedno úložiště GitHub pouze k jedné organizaci Azure DevOps.

Poznámka:

Když připojení provedete pomocí aplikace Azure Boards pro GitHub, aplikace vám zabrání v připojení ke dvěma různým organizacím. Pokud je úložiště GitHub nesprávně připojené k nesprávné organizaci Azure DevOps, musíte se obrátit na vlastníka této organizace, aby připojení odebral, abyste ho mohli přidat do správné organizace Azure DevOps.

Aktualizace definic XML pro vybrané typy pracovních položek

Pokud vaše organizace používá hostovaný model procesu XML nebo místní proces XML k přizpůsobení prostředí pro sledování práce a chcete propojit a zobrazit typy odkazů GitHubu z části Vývoj ve formulářích pracovních položek, budete muset aktualizovat definice XML pro typy pracovních položek.

Pokud například chcete propojit uživatelské scénáře a chyby s potvrzeními GitHubu a žádostmi o přijetí změn z části Vývoj , musíte aktualizovat definice XML pro uživatelské scénáře a chyby.

Postupujte podle posloupnosti úloh poskytovaných v modelu hostovaného procesu XML a aktualizujte definice XML. Pro každý typ pracovní položky najděte Group Label="Development" oddíl a do následující syntaxe kódu přidejte následující dva řádky, které podporují typy externích odkazů: GitHub Commit a GitHub Pull Request.

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

Po aktualizaci by se oddíl měl zobrazit následujícím způsobem.

<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>  

Další kroky