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 Arbeitsaufgaben 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 Syntax #mention für Commits und Verzweigungen verwenden oder !-Erwähnungen nutzen, um von Arbeitsaufgabendiskussionen aus auf GitHub-Pull-Anfragen zu verweisen. Alternativ können Sie einen Link zu einem GitHub-Commit, einer Pull-Anfrage oder einer Verzweigung direkt aus einem Azure Boards-Arbeitsauftrag hinzufügen.

Note

GitHub Integrationsunterstützung:

  • Azure DevOps Services: Integriert in GitHub.com- und GitHub Enterprise Server-Repositorys ü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
Erlaubnisse Contributor sowohl für das Azure Boards-Projekt als auch für das GitHub Repository.
Projektverbindung Das Azure Boards-Projekt ist mit dem GitHub-Repository verbunden, in dem die Commits, Pull-Anfragen und Branches vorhanden sind, zu denen oder von 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-Linktypen müssen Projekte, die das gehostete XML-Prozessmodell verwenden, die Arbeitsaufgabentypen aktualisieren. Weitere Informationen finden Sie unter Aktualisieren von XML-Definitionen für die Auswahl von Arbeitsaufgabentypen.

Verwenden Sie die folgende Syntax aus einem GitHub-Commit, Pull-Request oder Issue, um einen Link zu Ihrem Azure Boards-Arbeitselement 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 Workflowkategorie 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 Wie Zustände von Workflowkategorien in Backlogs und Boards von Azure Boards verwendet werden.

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 Links zu Azure Boards Arbeitsaufgaben 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 Links zu Azure Boards Arbeitsaufgaben 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 Links zu GitHub Problem 123 und Azure Boards Arbeitsaufgabe 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 unerwartete AB# Erwähnungsverknüpfung angezeigt. Weitere Informationen finden Sie unter Beheben von Verbindungsproblemen. Aus diesem Grund wird empfohlen, nur ein GitHub Repository mit Projekten zu verbinden, die in einer einzigen Azure DevOps Organisation definiert sind.

Wenn Sie einen Link zu einer Arbeitsaufgabe mithilfe von AB# in einer Beschreibung der Pullanforderung hinzufügen, werden diese Links im Abschnitt Development der GitHub Pullanforderung angezeigt. 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 von AB#-Links im Entwicklungsabschnitt von GitHub Pull Request.

Erstellen eines GitHub Branch aus einem Arbeitselement

Führen Sie die folgenden Schritte aus, um eine GitHub Verzweigung direkt aus einer Arbeitsaufgabe zu erstellen:

  1. Suchen Sie in Ihrem Board nach der Aufgabe, die Sie zum Erstellen eines GitHub-Branchs verwenden möchten.

  2. Wählen Sie Work item actions>New GitHub branch aus.

    Screenshot des Arbeitselements mit ausgewählter Option

  3. Geben Sie im Dialogfeld Ein GitHub Verzweigung erstellen den Verzweigungsnamen ein. Wählen Sie das GitHub-Repository und die Basis-Verzweigung aus.

  4. Wählen Sie "Erstellen" aus.

    Screenshot des Dialogfelds

    Azure Boards erstellt den Branch im angegebenen GitHub-Repository und verknüpft ihn mit dem Work Item. 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ü ihren linktyp, GitHub Repository und 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 Repository verknüpfte must mit dem Azure Boards Projekt verbunden werden 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 die inkrementellen Änderungen bei Commit, PR und Issue jede Stunde aus 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
Link zu Branch 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 Arbeitsaufgabenformular werden die Verknüpfungen aufgelistet, die zu GitHub-Commits und Pullanforderungen mithilfe des GitHub-Symbols erstellt wurden.

Screenshot des Arbeitsaufgabenformulars, der Entwicklungsabschnitt zeigt GitHub-Links.

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 Einblicke in Pull-Anforderungen anzuzeigen, wechseln Sie zur App Azure Boards in GitHub und akzeptieren Sie die aktualisierten Berechtigungen für Lese- und Schreibzugriff auf Checks.

Screenshot des Dialogfelds der Azure Boards GitHub-App-Berechtigungen, das die aktualisierten Prüfberechtigungen anzeigt.

Anzeigen der Statusdetails der Pullanforderung

  1. Öffnen Sie eine Arbeitsaufgabe, die über eine verknüpfte GitHub Pullanforderung verfügt.

  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 auf einen Statusindikator, um weitere Details anzuzeigen, oder wählen Sie den Pullanforderungslink aus, um ihn direkt in GitHub zu öffnen.

Erwähnen GitHub Pullanforderungen mithilfe von !

Verwenden Sie !-Erwähnungen, um auf GitHub Pull-Anfragen direkt aus einem Rich-Text-Feld eines Arbeitselements oder Diskussionskommentars zu verweisen und sie zu besprechen. Wenn Sie ! in ein Textfeld eingeben, wird ein Auswahlfeld angezeigt, mit dem Sie einen GitHub Pull-Request aus einem verbundenen Repository suchen und auswählen 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, das zeigt, wie man die !-Erwähnung verwendet, um auf einen GitHub-Pull-Request aus einer Arbeitsaufgabendiskussion zu verweisen.

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

Wenn Sie Azure Pipelines YAML zum Erstellen von Code verwenden, der in einem GitHub Repository gehostet wird, können Sie automatisch Integrated in BuildLinks zu zugehörigen Arbeitsaufgaben erstellen. Dieses Feature bietet Build-Rückverfolgbarkeit für GitHub Repos, 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.

GitHub-Objekte auf einem Board anzeigen

Indem Sie GitHub-Anmerkungen auf dem Board aktivieren, können Sie schnell verknüpfte GitHub-Commits, Pull-Requests oder Issues öffnen, um detaillierte Informationen zu erhalten. Weitere Informationen finden Sie unter Anpassen von Karten.

Screenshot des Boards mit den GitHub-Links auf Arbeitsaufgabenkarten.

Nächste Schritte

Konfigurieren von Statusabzeichen

Verwandte Inhalte

  • Last updated on