Konfigurieren einer Zweigrichtlinie für einen externen Dienst

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Verzweigungsrichtlinien sind ein leistungsstarkes Feature, um hochwertigen Code in Ihrem Repo sicherzustellen, indem Anforderungen für alle Pullanforderungen festgelegt werden. Externe Dienste können die PR-Status-API verwenden, um detaillierten Status für Ihre PRs zu posten. Die Zweigrichtlinie für externe Dienste bringt die Möglichkeit, dass diese 3. Parteidienste an dem PR-Workflow teilnehmen und Richtlinienanforderungen einrichten können. In diesem Artikel werden Sie durch den Prozess der Konfiguration einer Zweigrichtlinie für einen Dienst geleitet, der PR-Status veröffentlicht. Weitere Informationen zum PR-Status finden Sie unter Anpassen und Erweitern von Pull-Anforderungsworkflows mit Pull-Anforderungsstatus.

Hinweis

Das in diesem Artikel dokumentierte Feature erfordert TFS 2018 Update 2 oder höher.

Voraussetzungen

  • Eine Organisation in Azure DevOps mit einem Git-Repo. Wenn Sie keine Organisation haben, registrieren Sie sich, um Code in kostenlosen privaten Git-Repositorys hochzuladen und freizugeben.
  • Ein Dienst, der den Status für PRs veröffentlicht. Siehe Erstellen eines Pull-Anforderungsstatusservers.

Konfigurieren der Zweigrichtlinie

  1. Navigieren Sie zu CodeBranches>, und suchen Sie nach der Verzweigung, auf der Sie die Richtlinie konfigurieren möchten (normalerweise main oder develop). Wählen Sie im Kontextmenü die Option "Zweigrichtlinien " aus.

    Select Branch policies from the context menu

  2. Scrollen Sie nach unten, um Statusüberprüfungen zu finden. Wählen Sie die Schaltfläche + aus.

    Select the Add policy button

  3. Wählen Sie den Dienst aus, für den Sie eine Richtlinie aus der Liste erstellen möchten. Wenn der Status zuvor veröffentlicht wurde, können Sie sie aus der Liste auswählen; wenn es sich um eine neue Richtlinie handelt, können Sie den Namen der Richtlinie eingeben.

    Select the policy from the list

    • Richtlinienanforderung bestimmt, ob diese Richtlinie optional oder nicht erforderlich ist, um Pullanforderungen in den Zweig abzuschließen.
    • Autorisierte Identität wird verwendet, um diesen Status nur aus der angegebenen Identität zu erzwingen, wird für die Richtlinienausfüllung gezählt.
    • Zurücksetzensbedingungen werden verwendet, um zu bestimmen, wann ein geposteter Status nicht mehr gültig ist. Wenn der gepostete Status speziell für den neuesten Code (d. h. ein Build) festgelegt ist, überprüfen Sie den Status zurücksetzen , wenn sich der Status der Quellzweige ändert.
    • Optional legen Sie einen Pfadfilter fest. Erfahren Sie mehr über Pfadfilter in Verzweigungsrichtlinien .
    • Die Anwendbarkeit der Richtlinie bestimmt, ob diese Richtlinie sobald eine Pullanforderung erstellt wird, oder ob die Richtlinie nur dann angewendet wird, wenn der erste Status an die Pullanforderung gesendet wird.
    • Standardmäßiger Anzeigename ermöglicht Es Ihnen, einen optionalen Anzeigenamen für Ihre Richtlinie anzugeben.

Erstellen eines neuen Pull Requests

  1. Erstellen Sie eine neue Pullanforderung in die Zweigstelle, in der die Richtlinie definiert ist. Weitere Informationen finden Sie unter Erstellen einer Pullanforderung.

  2. Nach dem Erstellen der PR wird die neue Richtlinie im Abschnitt "Richtlinien" der PR-Detailansicht angezeigt. Zunächst wird die Richtlinie als nicht festgelegt angezeigt, bis der externe Dienst den Status gepostet hat.

    Policy status is visible in the Policies section

    Wenn der Dienst den Status gepostet hat, wird die Richtlinie entsprechend aktualisiert. Die Fertigstellung wird blockiert, bis die Richtlinie die PR genehmigt.

    Policy status updates

    Wenn die Richtlinienkriterien erfüllt sind und der Dienst einen succeeded Status bereitstellt, wird die PR genehmigt und abgeschlossen.

    Policy status approved and completion unblocked

Zusammenfassung

In diesem Artikel haben Sie gelernt, wie Sie eine Zweigrichtlinie für einen externen Dienst konfigurieren.