Freigeben über


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

Category Requirements
Erlaubnisse - Mitglied der Gruppe Projektsammlungsadministratoren. Wenn Sie das Projekt erstellt haben, verfügen Sie über Berechtigungen.
- Administrator oder owner der GitHub Organisation zum Installieren der Azure Boards App.
- Leseberechtigungen für das GitHub-Repository.
Projektmitgliedschaft Projektmitglied.

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

Ihre Installationssequenz kann aufgrund Ihrer Kontokonfiguration variieren. Befolgen Sie bei Bedarf die Bildschirmhinweise zwischen den folgenden Schritten.

  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. In Installieren & Autorisieren von Azure Boards wählen Sie die Repositories aus, die Sie mit Azure Boards verbinden möchten, und wählen Sie dann Installieren & Autorisieren.

    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 für weitere Projekte eine Verbindung herstellen möchten, können Sie dies später tun, wie weiter unten in diesem Artikel unter Konfigurieren anderer Projekte oder Repositorys beschrieben.

Zugriff auf die Azure Boards Organisation gewähren

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.

    Screenshot zeigt den Organisationszugriff 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 wechseln 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.

Verwenden der Verbindung

An diesem Punkt ist Ihre Azure Boards-GitHub Integration abgeschlossen. Sie können die nächsten Schritte überspringen oder sie durchgehen, um die im Zusammenhang mit der Verbindung unterstützten Funktionen zu verstehen.

  1. Wählen Sie in Ihrem Board Neue Arbeitsaufgabe aus, um eine neue Arbeitsaufgabe mit dem Namen "Badge zu README hinzufügen" – Problem (Basic), User Story (Agile) oder Product Backlog Item (Scrum) einzugeben, je nach prozessmodell, das von Ihrem Azure Boards Projekt verwendet wird.

    In Ihrem Board wird ein Arbeitselement mit dem Titel Badge zu README hinzufügen angezeigt.

  2. Öffnen Sie Ihr Arbeitselement, wechseln Sie zum Abschnitt Entwicklung und wählen Sie Link hinzufügen aus.

  3. Wählen Sie Link typeGitHub Pull Request aus.

  4. Wählen Sie das Repository aus und geben Sie die Pull-Request-ID und optional einen Kommentar ein.

  5. Wählen Sie Verbindung hinzufügen aus.

    Der Screenshot zeigt die Aktion Link hinzufügen in einer Benutzerstory, wobei die Repositoryauswahl und leere Felder für die Eingabe der Pullanforderungs-ID und eines optionalen Kommentars sichtbar sind.

    Im Hintergrund werden die folgenden Aktionen automatisch ausgeführt.

    • Fügt der README-Datei des ersten Repositories in der Liste der verbundenen GitHub-Repositories ein Abzeichen hinzu.
    • Erstellt einen GitHub Commit für das Update durch Hinzufügen des Badges zur README-Datei.
    • Erstellt eine GitHub Pullanforderung, um die an der README-Datei vorgenommenen Änderungen zusammenzuführen.
    • Verknüpft die GitHub Commit- und Pullanforderung mit der in Schritt 1 erstellten Arbeitsaufgabe.
  6. Wählen Sie ausgehend von Ihrem Arbeitselement den ersten Pull-Request-Link aus.

    Der Screenshot zeigt das Fehlerformular für eine Pull-Anforderung, die in GitHub geöffnet wurde.

    Der GitHub-Pull-Request wird in einem neuen Browser-Tab geöffnet.

  7. Wählen Sie Pull Request zusammenführen aus.

    Screenshot zeigt die Beispiel-Pullanforderung in GitHub.

  8. Wechseln Sie zu Ihrer Repository-README-Datei und zeigen Sie das hinzugefügte Badge an.

    Screenshot zeigt das GitHub Repo mit hinzugefügten Badge.

    Weitere Informationen finden Sie unter Status-Badges zu Ihrem GitHub-Repository hinzufügen.

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 ein Problem mit einer Verbindung auftritt, empfiehlt es sich, die Verbindung zu entfernen und mit einer neuen Verbindung zu beginnen.

  1. Wechseln Sie in Ihrem Projekt in Azure DevOps zu Projekteinstellungen>GitHub connections.

  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 anzuhalten, wählen Sie Anhalten aus. Wählen Sie im Bestätigungsfenster "OK " aus, um das Anhalten zu bestätigen.

    Screenshot des Dialogfelds zur Bestätigung des Anhaltens.

    Wenn Sie das Anhalten der Integration aufheben möchten, wählen Sie Fortsetzen aus.

  3. Um die Azure Boards-App zu deinstallieren, wählen Sie Uninstall aus, und wählen Sie 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-Repositorys.

Screenshot zeigt deinstallierte Azure Boards GitHub app.

Nächste Schritte