Installieren der Azure Boards-App für GitHub

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

In dieser Schnellstartanleitung installieren Sie die Azure Boards-App für GitHub, um Azure Boards mit Ihren GitHub Repositorys zu verbinden. Wenn Sie Azure Boards Projekte mit GitHub.com Repositorys verbinden, unterstützen Sie die Verknüpfung zwischen GitHub Commits und Pullanforderungen an Arbeitsaufgaben. Sie können GitHub für die Softwareentwicklung verwenden, während Sie Azure Boards verwenden, um Ihre Arbeit zu planen und nachzuverfolgen. Nachdem Sie die Azure Boards-App für GitHub in Ihrem GitHub Konto oder Ihrer Organisation installiert haben, wählen Sie aus, mit welchen GitHub Repositorys Sie eine Verbindung mit Ihrem Projekt herstellen möchten.

Eine Übersicht über die Integration, die die Azure Boards-App für GitHub unterstützt, finden Sie unter Azure Boards-GitHub-Integration.

Prerequisites

Berechtigungskategorie Requirements
Azure DevOps - Mitglied der Gruppe Projektsammlungsadministratoren. Wenn Sie das Projekt erstellt haben, verfügen Sie über diese Berechtigung.
- Projektmitglied im Azure Boards-Projekt.
GitHub - Administrator oder Besitzer der GitHub Organisation zum Installieren der Azure Boards-App
- Leseberechtigungen für das GitHub Repository

Important

  • Wenn Ihr Repository bereits über einen anderen Authentifizierungstyp wie OAuth verbunden ist, müssen Sie dieses Repository aus Ihrer vorhandenen Verbindung entfernen, bevor Sie sie mithilfe der GitHub App erneut verbinden. Führen Sie die in Add oder Entfernen GitHub Repositorys weiter unten in diesem Artikel beschriebenen Schritte aus, bevor Sie die GitHub App konfigurieren.
  • Sie können eine Azure DevOps Organisation mit mehreren GitHub Repositorys verbinden, wenn Sie administrator für diese Repositorys sind. Sie sollten kein GitHub-Repository mit mehr als einer Azure DevOps-Organisation verbinden.

Installieren und Konfigurieren der Azure Boards-App

Die folgenden Schritte zeigen eine typische Installationssequenz. Folgen Sie allen Bildschirmaufforderungen, um das Setup abzuschließen.

  1. Wechseln Sie zur Azure Boards App im GitHub Marketplace.

  2. Wählen Sie unter "Pläne und Preise" unter "Kostenlos" die Option "Installieren" aus.

  3. Wählen Sie unter Installieren & Azure Boards autorisieren die Repositories aus, die Sie mit Azure Boards verbinden möchten, und wählen Sie dann Installieren & autorisieren aus.

    In diesem Beispiel werden alle Repositorys verwendet:

    Screenshot zeigt die Seite

  4. Wählen Sie die Azure DevOps Organisation und Azure Boards Projekt aus, das Sie mit GitHub.com verbinden möchten.

    Screenshot zeigt die Seite

    Sie können jeweils nur ein Projekt verbinden. Wenn Sie andere Projekte verbinden möchten, lesen Sie " Konfigurieren anderer Projekte oder Repositorys".

Gewähren Sie Zugriff auf die Azure Boards-Organisation

Führen Sie die folgenden Schritte aus, um GitHub Zugriff auf Ihre Azure DevOps Organisation zu gewähren.

  1. Öffnen Sie im GitHub Webportal Settings aus Ihrem Profilmenü.

    Screenshot der Option

  2. Wählen Sie unter IntegrationenAnwendungen aus.

  3. Wählen Sie Authorized GitHub Apps>Azure Boards aus.

    Screenshot zeigt autorisierte GitHub Apps mit Azure Boards hervorgehoben.

  4. Unter Organisationszugriff können alle auftretenden Probleme behoben werden. Wählen Sie Gewähren aus, um allen Organisationen Zugriff zu gewähren, für die Zugriffsanforderung ausstehend angezeigt wird.

    Ein Screenshot zeigt den Zugriff von Organisationen mit Organisationen ohne Zugriff.

Überprüfen der Anwendungszugriffsrichtlinie von Drittanbietern

Stellen Sie sicher, dass Ihre GitHub Organisation den Anwendungszugriff von Drittanbietern für die Azure Boards-App zulässt. Wenn der Zugriff von Drittanbietern eingeschränkt ist, kann das Hinzufügen von Repositorys aus Azure DevOps eine leere Liste anzeigen oder einen Fehler erzeugen.

So aktivieren Sie den Zugriff:

  1. Öffnen Sie in GitHub Ihre Organisation und gehen Sie zu Einstellungen>OAuth-App-Richtlinie.

  2. Genehmigen Sie die Azure Boards-App speziell (empfohlen), oder entfernen Sie Einschränkungen für alle Anwendungen von Drittanbietern.

    Screenshot der Anwendungszugriffsrichtlinie von Drittanbietern.

Hinweis

Sie müssen ein Organisationsbesitzer oder Administrator sein, um diese Einstellung zu ändern.

Nachdem Sie Ihre Azure Boards-GitHub-Integration konfiguriert haben, können Sie Ihre Arbeitsaufgaben mit GitHub Pullanforderungen und Commits verknüpfen.

Im folgenden Beispiel wird die Integration veranschaulicht, indem eine Arbeitsaufgabe erstellt und mit einer Pullanforderung verknüpft wird:

  1. Wählen Sie in Ihrem Board " Neue Arbeitsaufgabe " aus, um eine Arbeitsaufgabe zu erstellen. Verwenden Sie in diesem Beispiel den Titel "Badge zu README hinzufügen". Der Arbeitsaufgabentyp hängt von Ihrem Prozess ab: Issue (Basic), User Story (Agile) oder Product Backlog Item (Scrum).

    Das neue Arbeitselement erscheint auf Ihrem Board.

  2. Öffnen Sie Ihre Arbeitsaufgabe, und wechseln Sie zum Abschnitt "Entwicklung" .

  3. Wählen Sie "Link hinzufügen" und dann GitHub Pullanforderung aus dem Menü "Linktyp" aus.

  4. Wählen Sie das Repository aus, und geben Sie die Pull-Anforderungs-ID ein. Sie können auch einen optionalen Kommentar hinzufügen.

  5. Wählen Sie "Link hinzufügen" aus, um die Verbindung zu erstellen.

    Azure Boards führt automatisch die folgenden Aktionen im Hintergrund aus:

    • Fügt der README-Datei des ersten Repositories in der Liste der verbundenen GitHub-Repositories ein Abzeichen hinzu.
    • Erstellt einen GitHub-Commit für die Badge-Aktualisierung.
    • Erstellt eine GitHub Pullanforderung zum Zusammenführen der Änderungen an der README-Datei
    • Verknüpft die GitHub Commit- und Pullanforderung mit Ihrer Arbeitsaufgabe.
  6. Wählen Sie in Ihrer Arbeitsaufgabe den Pullanforderungslink aus, um ihn in GitHub zu öffnen.

  7. Wählen Sie "Zusammenführen"-Pullanforderung in GitHub aus.

  8. Öffnen Sie in Ihrem GitHub-Repository die README-Datei, um zu prüfen, ob das Badge hinzugefügt wurde. Weitere Informationen finden Sie unter Statusbadges konfigurieren, die GitHub-README-Dateien hinzugefügt werden sollen.

Konfigurieren anderer Projekte oder Repositorys

Sie können andere Azure Boards/Azure DevOps Projekte, GitHub.com Repositorys konfigurieren oder die aktuelle Konfiguration von der Azure Boards-App-Seite ändern. Weitere Informationen finden Sie unter Hinzufügen oder Entfernen von Repositorys oder Entfernen einer Verbindung aus Azure Boards.

Hinzufügen oder Entfernen von Repositorys oder Entfernen einer Verbindung aus Azure Boards

Wenn bei einer Verbindung ein Problem auftritt, entfernen Sie die Verbindung, und beginnen Sie mit einer neuen Verbindung.

  1. Wählen Sie in Ihrem Projekt in Azure DevOps Projekteinstellungen>GitHub-Verbindungen aus.

  2. Um Repositorys hinzuzufügen oder zu entfernen, wählen Sie die Auslassungspunkte für Weitere Optionen aus, um die Verbindung herzustellen, und wählen Sie im Menü Repositorys hinzufügen oder Repositorys entfernen aus.

    Screenshot zeigt das GitHub Verbindungsmenü

  3. Um alle Repositorys und die Verbindung zu entfernen, wählen Sie die Option Verbindung entfernen aus. Wählen Sie dann zur Bestätigung Entfernen aus.

    Screenshot zeigt die Entfernungsbestätigung der GitHub-Verbindung.

Ändern des Repositoryzugriffs

  1. Öffnen Sie im GitHub Webportal Settings aus Ihrem Profilmenü.

  2. Wählen Sie "Integrationsanwendungen>" aus. Wählen Sie unter Installed GitHub AppsConfigure aus.

    Screenshot zeigt die installierten GitHub Apps mit Azure Boards und die Option

    Die Azure Boards Konfigurationsseite wird geöffnet.

  3. Scrollen Sie nach unten zum Abschnitt Repositoryzugriff.

  4. Wählen Sie die gewünschte Option aus, Alle Repositorys oder Nur Repositorys auswählen.

    Wenn Sie Nur ausgewählte Repositorys auswählen, wählen Sie die Repositorys aus, in der die Integration mit Azure Boards erfolgen soll.

    Screenshot des Repositoryzugriffs, in dem Sie ausgewählte Repositorys auswählen können.

  5. Wählen Sie Speichern aus.

Anhalten oder Deinstallieren der Azure Boards-Integration

  1. Scrollen Sie ab Schritt 2 im vorherigen Verfahren nach unten zum Abschnitt Gefahrenzone.

    Screenshot des Abschnitts

  2. Um die Integration zu pausieren, wählen Sie Aussetzen. Wählen Sie im Bestätigungsfenster "OK " aus, um das Anhalten zu bestätigen.

    Screenshot des Dialogfelds zur Bestätigung des Anhaltens.

    Um die Integration zu aufheben, wählen Sie "Unsuspend" aus.

  3. Um die Azure Boards-App zu deinstallieren, wählen Sie "Deinstallieren" und dann im Popupbestätigungsfenster "OK" aus.

    Screenshot des Dialogfelds

Aktualisieren von Azure Boards-GitHub-Verbindungen

Wenn Sie die Repositorys ändern, die von der Azure Boards-App für GitHub unterstützt werden, werden Sie möglicherweise zu Azure Boards GitHub Verbindungen umgeleitet. Es empfiehlt sich, die Repositorys in Azure Boards zu entfernen, die keine Verbindung mit GitHub mehr herstellen können. Weitere Informationen finden Sie unter Hinzufügen oder Entfernen von GitHub-Repositorien.

Wenn Sie die Azure Boards-App für GitHub deinstallieren, wird die folgende Meldung in Azure Boards angezeigt, Project settings>GitHub connections. Wählen Sie "Verbindung entfernen" aus, um alle zuvor vorgenommenen GitHub Verbindungen zu entfernen. Weitere Informationen finden Sie unter Hinzufügen oder Entfernen von GitHub-Repositorien.

Screenshot zeigt deinstallierte Azure Boards GitHub app.

Integrationsprobleme beheben

Leere Repositoryliste beim Hinzufügen von Repositorys

Wenn die Repositoryliste in Azure DevOps leer angezeigt wird:

  • Überprüfen Sie, ob Ihre GitHub Organisation den App-Zugriff von Drittanbietern aktiviert hat.
  • Stellen Sie sicher, dass Sie Azure Boards Berechtigung für den Zugriff auf Ihre Organisation erteilt haben, und gewähren Sie Azure Boards Organisationszugriff.
  • Überprüfen Sie in GitHub die Einstellungen Ihrer Organisation > Installierte GitHub-Apps > Azure Boards > Organisationszugriff. Wenn der Status „Zugriffsanforderung steht aus“ angezeigt wird, wählen Sie Genehmigen aus, um die Anforderung zu genehmigen.

Status "Zugriffsanforderung ausstehend" hängen geblieben

Wenn der Zugriff für die Organisation noch aussteht:

  • Sie müssen ein GitHub Organisationsbesitzer oder -administrator sein, um die Anforderung zu genehmigen.
  • Wählen Sie Gewähren im Abschnitt „Organisationszugriff“ in den Einstellungen für Ihre autorisierten Apps aus.
  • Wenn das Problem weiterhin besteht, deinstallieren Sie die Azure Boards-App und installieren Sie sie erneut, indem Sie die Schritte unter Installieren und Konfigurieren der Azure Boards-App befolgen.

Badge wird nach dem Verknüpfen des Pull Requests nicht angezeigt

Wenn das Badge nach dem Verknüpfen eines Pull Requests nicht in Ihrer README-Datei angezeigt wird:

  • Das Abzeichen wird nur angezeigt, wenn Sie den Pull Request verknüpfen und das Repository das erste in Ihrer verbundenen Liste ist.
  • Überprüfen Sie, ob die PR, auf die Sie verlinkt haben, noch geöffnet ist (zusammengeführte PRs lösen keine Badge-Erstellung aus).
  • Überprüfen Sie, ob Azure Boards Schreibzugriff auf Ihr Repository hat.

Authentifizierungs- oder Berechtigungsfehler

Wenn während des Setups Authentifizierungsfehler angezeigt werden:

  • Vergewissern Sie sich, dass Sie ein Organisationsbesitzer oder Administrator in GitHub sind.
  • Stellen Sie sicher, dass Ihre GitHub Organisation den Zugriff auf Anwendungen von Drittanbietern nicht eingeschränkt hat.
  • Überprüfen Sie, ob Sie über Leseberechtigungen für das Repository verfügen, das Sie verbinden möchten.
  • Versuchen Sie, sich von GitHub ab- und wieder anzumelden, und versuchen Sie dann die Autorisierung erneut.

Nächster Schritt