Konfigurieren einer Branch-Richtlinie für einen externen Dienst

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

Branchrichtlinien sind ein leistungsstarkes Feature, um qualitativ hochwertigen Code in Ihrem Repository sicherzustellen, indem Anforderungen für alle Pull Requests festgelegt werden. Externe Dienste können die PR-Status-API verwenden, um detaillierte Status für Ihre PRs zu posten. Die Branchrichtlinie für externe Dienste bietet diesen Drittanbieterdiensten die Möglichkeit, am PR-Workflow teilzunehmen und Richtlinienanforderungen festzulegen. Dieser Artikel führt Sie durch den Prozess zum Konfigurieren einer Branchrichtlinie für einen Dienst, der PR-Status postet. Weitere Informationen zu PR-Status finden Sie unter Anpassen und Erweitern von Pull Request-Workflows mit Pull Request-Status.

Voraussetzungen

• Eine Organisation in Azure DevOps mit einem Git-Repository. Wenn Sie über keine Organisation verfügen, registrieren Sie sich, um Code in unbegrenzten kostenlosen privaten Git-Repositorys hochzuladen und freizugeben.
• Ein Dienst, der Status an PRs postet. Siehe Erstellen eines Pull Request-Statusservers.

Konfigurieren der Branchrichtlinie

1. Navigieren Sie zu Code>Branches, und suchen Sie den Branch, für den Sie die Richtlinie konfigurieren möchten (in der Regel main oder develop). Wählen Sie im Kontextmenü die Option Branchrichtlinien aus.

   

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

   

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

   

   • Die Richtlinienanforderung bestimmt, ob diese Richtlinie optional oder erforderlich ist, um Pull Requests in den Branch abschließen zu können.
   • Die autorisierte Identität wird verwendet, um zu erzwingen, dass nur Status von der angegebenen Identität auf die Richtlinienerfüllung angerechnet werden.
   • Zurücksetzungsbedingungen werden verwendet, um zu bestimmen, wann eine geposteter Status nicht mehr gültig ist. Wenn der gepostete Status spezifisch für den neuesten Code (d. h. einen Build) ist, aktivieren Sie Status bei neuen Änderungen immer zurücksetzen, um den Status zurückzusetzen, wenn sich der Quellbranch ändert.
   • Legen Sie optional einen Pfadfilter fest. Erfahren Sie mehr über Pfadfilter in Branchrichtlinien.
   • Die Anwendbarkeit von Richtlinien legen fest, ob diese Richtlinie gilt, sobald ein Pull Request erstellt wird, oder ob die Richtlinie erst gilt, nachdem der erste Status für den Pull Request veröffentlicht wurde.
   • Mit dem Standardanzeigenamen können Sie einen optionalen Anzeigenamen für Ihre Richtlinie angeben.

Erstellen eines neuen Pull Requests

1. Erstellen Sie einen neuen Pull Request in dem Branch, in dem die Richtlinie definiert ist. Weitere Informationen finden Sie unter Erstellen eines Pull Requests.

2. Nach dem Erstellen des 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 einen Status gepostet hat.

   

   Sobald der Dienst einen Status gepostet hat, wird die Richtlinie entsprechend aktualisiert. Der Abschluss wird blockiert, bis die Richtlinie den PR genehmigt.

   

   Wenn die Richtlinienkriterien erfüllt sind und der Dienst einen succeeded-Status postet, wird der PR genehmigt, und die Blockierung des Abschlusses wird aufgehoben.

   

Zusammenfassung

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