Freigeben über


Verknüpfen von GitHub-Commits, Pull-Requests, Branches und Issues mit Arbeitsaufgaben in Azure Boards

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

In diesem Artikel erfahren Sie, wie Sie Arbeitselemente mit GitHub-Commits, Pullanforderungen, Verzweigungen und Builds verknüpfen, nachdem Sie Ihr Azure Boards-Projekt mit einem GitHub-Repository verbunden haben. Sie können die #mention-Syntax für Commits und Verzweigungen verwenden, Erwähnungen ! verwenden, um auf GitHub-Pullanforderungen aus Arbeitsaufgabendiskussionen zu verweisen, oder einen GitHub-Commit, pull-Anforderungs- oder Verzweigungslink direkt aus der Arbeitsaufgabe von Azure Boards hinzufügen.

Note

Unterstützung der GitHub-Integration:

  • Azure DevOps Services: Integriert sich sowohl in GitHub.com- als auch in GitHub Enterprise Server-Repositories über die Azure Boards-App für GitHub.
  • Azure DevOps Server 2020 und höher: Unterstützt nur die Integration in GitHub Enterprise Server-Repositorys.
  • Andere Git-Repositorys: Die Integration wird nicht unterstützt.

Prerequisites

Category Requirements
Permissions Mitwirkender sowohl des Azure Boards-Projekts als auch des GitHub-Repositorys.
Projektverbindung Das Azure Boards-Projekt ist mit dem GitHub-Repository verbunden, in dem die Commits, Pull-Anfragen und Branches vorhanden sind, mit denen Sie eine Verknüpfung herstellen möchten. Weitere Informationen finden Sie unter Azure Boards-GitHub Integration.

Note

Zum Anzeigen des Abschnitts "Entwicklung" und der GitHub-Verknüpfungstypen erfordern Projekte, die das Gehostete XML-Prozessmodell verwenden, Aktualisierungen der Arbeitsaufgabentypen. Weitere Informationen finden Sie unter Aktualisieren von XML-Definitionen für die Auswahl von Arbeitsaufgabentypen.

Verwenden Sie aus einem GitHub-Commit, einer Pullanforderung oder einem Problem die folgende Syntax, um einen Link zu Ihrer Azure Boards-Arbeitsaufgabe zu erstellen. Geben Sie AB#ID im Text einer Commitnachricht ein. Oder geben Sie für eine Pullanforderung oder ein Problem das AB#ID in die Beschreibung ein. Die Verwendung von AB#ID in einem Kommentar- oder Pull Request-Titel erstellt keinen Link im Arbeitselement.

AB#{ID}

AB#125 verknüpft beispielsweise zu Arbeitselement-ID 125.

Sie können auch eine Commit- oder Pull Request-Nachricht eingeben, um den Status des Arbeitselements zu ändern. Das System erkennt {state} oder {state category}, zusammen mit fix, fixes und fixed, und wendet es auf das folgende #-Mention-Element an.

Wenn eine Beschreibung der Pullanforderung beispielsweise einen gültigen Statusnamen enthält, Closed AB#1234aktualisiert das System die Referenzarbeitsaufgabe in diesen spezifischen Zustand. Wenn der Statusname nicht direkt erkannt wird, versucht Azure Boards, ihn einer Workflow-Kategorie wie Resolved oder Completed zuzuordnen. Wenn eine Übereinstimmung gefunden wird, wechselt die Arbeitsaufgabe in den ersten verfügbaren Zustand, der unter dieser Kategorie definiert ist.

Standardmäßig wechseln Arbeitsaufgaben, die mit fix, fixes, oder fixed referenziert werden, in den ersten Zustand, der mit der Kategorie "Aufgelöst" verknüpft ist. Wenn im aktuellen Prozess kein solcher Zustand vorhanden ist, übergibt das System stattdessen die Arbeitsaufgabe in den ersten Zustand in der Kategorie "Abgeschlossen ".

Important

Sie können weiterhin Arbeitselemente verknüpfen und andere Branches anvisieren, aber Statusübergangsregeln gelten nicht, es sei denn, der Pull-Request wird in den Standard-Branch gemerged.

Weitere Informationen finden Sie unter Verwendung von Workflowkategoriestatus in Backlogs und Boards von Azure Boards.

Die folgende Tabelle enthält Beispiele:

Commit- oder Pull Request-Nachricht Action
Fixed AB#123 Verknüpft und übergibt die Arbeitsaufgabe zur Kategorie "Aufgelöster Workflowstatus" oder, wenn keine definiert ist, die Kategorie " Abgeschlossener Workflowstatus".
Closed AB#123 Verknüpft und übergibt die Arbeitsaufgabe in den Zustand "Geschlossener Workflow". Wenn keine definiert ist, werden keine Übergänge vorgenommen.
Adds a new feature, fixes AB#123. Verknüpft und übergibt die Arbeitsaufgabe zur Kategorie "Aufgelöster Workflowstatus" oder, wenn keine definiert ist, die Kategorie " Abgeschlossener Workflowstatus".
Fixes AB#123, AB#124, and AB#126 Verknüpfungen zu Azure Boards-Arbeitselementen 123, 124 und 126. Überführt nur das erste Element, 123, in den Workflowstatus „Aufgelöster“ oder, wenn keiner definiert ist, in den Workflowstatus „Abgeschlossener“.
Fixes AB#123, Fixes AB#124, Fixes AB#125 Verknüpfungen zu Azure Boards-Arbeitselementen 123, 124 und 126. Übergibt alle Elemente in die Kategorie "Aufgelöster Workflowstatus" oder , wenn keine definiert ist, die Kategorie " Abgeschlossener Workflowstatus".
Fixing multiple bugs: issue #123 and user story AB#234 Verknüpfungen zu GitHub-Issue 123 und Azure Boards-Arbeitselement 234. Es werden keine Übergänge durchgeführt.

Note

Wenn Sie dasselbe GitHub-Repository mit Projekten verbunden haben, die in zwei oder mehr Azure DevOps-Organisationen definiert sind, wird möglicherweise eine unerwartete AB#-Referenzverknüpfung angezeigt. Weitere Informationen finden Sie unter Beheben von Verbindungsproblemen. Aus diesem Grund sollten Sie ein GitHub-Repository nur mit Projekten verbinden, die in einer einzelnen Azure DevOps-Organisation definiert sind.

Wenn Sie einen Link zu einer Arbeitsaufgabe mithilfe der Beschreibung eines Pull-Requests AB# hinzufügen, erscheinen diese Links im Abschnitt "Entwicklung" der GitHub-Pull-Request. Diese Links sind nur verfügbar, wenn Sie in der Beschreibung der Pull-Anforderung verwenden AB# . Sie werden nicht angezeigt, wenn Sie direkt aus dem Arbeitselement einen Link zum Pull Request herstellen. Wenn Sie den AB# Verweis aus der Beschreibung entfernen, wird er auch aus dem Abschnitt "Entwicklung" entfernt.

Screenshot der AB#-Links im Entwicklungsabschnitt der GitHub-Pullanforderung.

Erstellen einer GitHub-Verzweigung aus einem Arbeitselement

Führen Sie die folgenden Schritte aus, um einen GitHub-Branch direkt aus einer Arbeitsaufgabe zu erstellen:

  1. Finden Sie in Ihrem Board das Arbeitselement, das Sie verwenden möchten, um einen GitHub-Branch zu erstellen.

  2. Wählen Sie Aktionen für Arbeitselement>Neue GitHub-Verzweigung aus.

    Screenshot der Arbeitsaufgabe „Weitere Aktionen auswählen“ und der hervorgehobenen Option „Neue GitHub-Verzweigung“.

  3. Geben Sie im Dialogfeld " GitHub-Verzweigung erstellen" den Verzweigungsnamen ein. Wählen Sie das GitHub-Repository und den Base Branch aus.

  4. Wählen Sie "Erstellen" aus.

    Screenshot des Dialogfelds

    Azure Boards erstellt die Verzweigung im angegebenen GitHub-Repository und verknüpft sie mit dem Arbeitselement. Weitere Informationen finden Sie unter Azure Boards-GitHub Integration.

  1. Öffnen Sie Ihre Arbeitsaufgabe, und wechseln Sie zum Bereich "Entwicklung ".

  2. Wählen Sie Verbindung hinzufügen aus. Wählen Sie in jedem Dropdownmenü Den Linktyp, das GitHub-Repository und die GitHub-Pullanforderung aus. Sie können innerhalb des Repositorys suchen und einen Drilldown ausführen, um eine bestimmte Pullanforderung oder einen Commit auszuwählen, ohne eine URL kopieren und einfügen zu müssen.

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

    Screenshot der fünfstufigen Sequenz zum Hinzufügen eines Pullanforderungslinks zur Arbeitsaufgabe.

    Azure Boards überprüft, ob Sie einen gültigen Link eingegeben haben. Das mit GitHub verknüpfte Repository muss mit dem Azure Boards-Projekt verbunden sein , oder die Überprüfung schlägt fehl.

Note

Wenn Sie Azure DevOps Server und GitHub Enterprise Server verwenden, ist beim Abschließen der AB#-Links eine Verzögerung vorhanden. Der Prozess verwendet ein "Push-and-Pull"-Design, um jede Stunde die inkrementellen Änderungen bei Commit, PR und Issue von den GitHub-Ereignissen abzurufen.

Mehrere Ereignisse aktualisieren die Verknüpfungen im Arbeitsaufgabenformular automatisch, sodass Sie sie nicht manuell erstellen müssen. Zu diesen Ereignissen gehören:

GitHub-Ereignis Action
Verknüpfung zur Verzweigung Wenn eine Pullanforderung aus einer Verzweigung erstellt wird, wird sie automatisch mit der Arbeitsaufgabe verknüpft.
Zusammenführen des Commits Nachdem die Pullanforderung zusammengeführt wurde, wird der resultierende Zusammenführungsvorgang automatisch mit der Arbeitsaufgabe verknüpft.
Verzweigung löschen Wenn eine Verzweigung gelöscht wird (typischerweise nach dem Zusammenführen), wird der Link automatisch aus dem Arbeitsobjekt entfernt.

Im Abschnitt "Entwicklung" im Formular "Arbeitsaufgabe" werden die Links zu GitHub-Commits und Pull-Anfragen aufgelistet, die mithilfe des GitHub-Symbols erstellt wurden.

Screenshot des Arbeitsaufgabenformulars, Abschnitt

Wählen Sie den Link aus, um die Commit- oder Pullanforderung in GitHub zu öffnen.

GitHub-Pull-Request-Einblicke

Verknüpfte GitHub-Pullanforderungen im Abschnitt "Entwicklung" zeigen zusätzliche Statusdetails an, sodass Sie den Fortschritt bewerten können, ohne die Pullanforderung in GitHub zu öffnen.

Voraussetzungen für Einblicke in Pull-Anfragen

Um Pull-Request-Einblicke anzuzeigen, wechseln Sie zur Azure Boards-App in GitHub und akzeptieren Sie die aktualisierten Berechtigungen für Lese- und Schreibzugriff auf Überprüfungen.

Screenshot des Azure Boards GitHub-App-Berechtigungsdialogfelds mit den aktualisierten Überprüfungsberechtigungen.

Anzeigen der Statusdetails der Pullanforderung

  1. Öffnen Sie eine Arbeitsaufgabe mit einer verknüpften GitHub-Pullanforderung.

  2. Suchen Sie im Abschnitt "Entwicklung " die verknüpfte Pullanforderung. Die folgenden Statusdetails werden neben dem Pullanforderungslink angezeigt:

    • Entwurfsstatus: Zeigt an, ob die Pullanforderung noch ein Entwurf ist.
    • Überprüfungsstatus: Zeigt an, ob die Pull Request eine Überprüfung benötigt, genehmigt wurde oder Änderungen angefordert wurden.
    • Status der Überprüfungen: Zeigt an, ob CI-Prüfungen bestanden, nicht bestanden oder in Bearbeitung sind.

    Screenshot des Abschnitts

  3. Zeigen Sie mit der Maus auf einen Statusindikator, um weitere Details anzuzeigen, oder wählen Sie den Pullanforderungslink aus, um ihn direkt in GitHub zu öffnen.

Erwähnen von GitHub-Pullanforderungen mithilfe von !

Verwenden Sie !-Erwähnungen, um direkt aus jedem Rich-Text-Feld oder Diskussionskommentar auf GitHub-Pull-Requests zu verweisen und diese zu diskutieren. Wenn Sie ! in ein Textfeld eingeben, wird eine Auswahl angezeigt, die Sie zum Suchen und Auswählen eines GitHub-Pull-Requests aus einem verknüpften Repository verwenden können. Die ausgewählte Pullanforderung wird als klickbarer Link eingefügt.

Dieses Feature erleichtert das Verweisen auf verwandte Pullanforderungen in Arbeitsaufgabenbeschreibungen, Akzeptanzkriterien oder Diskussionsthreads ohne manuelles Kopieren von URLs.

Gif zeigt, wie man die ! Erwähnung nutzt, um aus einer Arbeitsaufgabendiskussion auf eine GitHub-Pull-Request zu verweisen.

Anzeigen des Buildstatus für YAML-Pipelines (integriert in Build)

Wenn Sie Azure Pipelines YAML verwenden, um Code zu erstellen, der in einem GitHub-Repository gehostet wird, können Sie automatisch integrierte Links zu zugehörigen Arbeitsaufgaben erstellen. Dieses Feature bietet Buildablaufverfolgungsmöglichkeiten für GitHub-Repositorys, wodurch die Parität mit der für Azure Repos verfügbaren Oberfläche erreicht wird.

Sie können dieses Feature wie folgt aktivieren:

  1. Öffnen Sie Ihre YAML-Pipeline, wählen Sie "Weitere Aktionen" und dann " Einstellungen" aus.

  2. Aktivieren Sie im Dialogfeld "Pipelineeinstellungen " die Option "Neue Arbeitsaufgaben automatisch verknüpfen" in diesem Build.

    Screenshot des Dialogfelds „YAML-Pipelineeinstellungen“, das die Option „Neue Arbeitsaufgaben in diesem Build automatisch verknüpfen“ zeigt.

Wenn der Build abgeschlossen ist, erscheint automatisch im Abschnitt Entwicklung jedes zugeordneten Arbeitselements ein integrierter Build-Link, sodass Ihr Team eine vollständige Nachverfolgbarkeit von Arbeitselement zu Build ermöglicht.

Screenshot der Arbeitsaufgabe mit dem Link

Weitere Informationen zum Konfigurieren dieser Einstellung finden Sie unter Konfigurieren von Pipelines zur Unterstützung der Arbeitsnachverfolgung.

Anzeigen von GitHub-Objekten auf einem Board

Indem Sie GitHub-Anmerkungen auf dem Board aktivieren, können Sie verknüpfte GitHub-Commits, Pullanforderungen oder Probleme schnell öffnen, um weitere Details zu erhalten. Weitere Informationen finden Sie unter Anpassen von Karten.

Screenshot der Tafel, die GitHub-Links auf Arbeitselementkarten zeigt.

Nächste Schritte