YAML-Pipeline-Editor

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

Azure Pipelines stellt einen YAML-Pipeline-Editor bereit, mit dem Sie Ihre Pipelines erstellen und bearbeiten können. Der YAML-Editor basiert auf dem Monaco-Editor. Der Editor bietet Tools wie IntelliSense-Unterstützung und einen Aufgaben-Assistenten, der beim Bearbeiten einer Pipeline Anleitungen bereitstellt.

In diesem Artikel erfahren Sie, wie Sie Ihre Pipelines mit dem YAML-Pipeline-Editor bearbeiten, aber Sie können auch Pipelines bearbeiten, indem Sie die Datei azure-pipelines.yml direkt im Repository Ihrer Pipeline mithilfe eines Text-Editors Ihrer Wahl oder mithilfe eines Tools wie Visual Studio Code und der Erweiterung Azure Pipelines für VS Code ändern.

Wichtig

Der YAML-Pipeline-Editor wurde in Azure DevOps Server 2019 Update 1 eingeführt. Wenn Sie Azure DevOps Server 2019 RTW verwenden, ist der in diesem Artikel beschriebene YAML-Pipeline-Editor nicht verfügbar. Bearbeiten Sie YAML-Code in diesem Fall mit einem beliebigen Text-Editor, und checken Sie ihn anschließend in das Repository Ihrer Pipeline ein.

Bearbeiten einer YAML-Pipeline

Führen Sie die folgenden Schritte aus, um auf den YAML-Pipeline-Editor zuzugreifen:

  1. Melden Sie sich bei Ihrer Organisation an (https://dev.azure.com/{yourorganization}).

  2. Wählen Sie Ihr Projekt aus, und klicken Sie auf Pipelines>Pipelines. Wählen Sie anschließend die Pipeline aus, die Sie bearbeiten möchten.

    Azure Pipelines-Builds in Azure DevOps Server 2019 Update 1

  3. Wählen Sie Bearbeiten aus.

    Schaltfläche „Bearbeiten“ für YAML-Code in Azure Pipelines (Azure DevOps Server 2019 Update 1)

  4. Nehmen Sie Bearbeitungen an Ihrer Pipeline mithilfe von IntelliSense-Tastenkombinationen und dem Aufgaben-Assistenten vor.

    YAML-Pipeline-Editor in Azure DevOps Server 2019.1

Führen Sie die folgenden Schritte aus, um auf den YAML-Pipeline-Editor zuzugreifen:

  1. Melden Sie sich bei Ihrer Organisation an (https://dev.azure.com/{yourorganization}).

  2. Wählen Sie Ihr Projekt aus, und klicken Sie auf Pipelines. Wählen Sie anschließend die Pipeline aus, die Sie bearbeiten möchten. Sie können die Pipelines nach Zuletzt verwendet, Alle und Wird ausgeführt durchsuchen. Weitere Informationen finden Sie unter Anzeigen und Verwalten von Pipelines.

    Azure Pipelines-Startseite

  3. Wählen Sie Bearbeiten aus.

    Schaltfläche „Bearbeiten“ für YAML-Code in Azure Pipelines

  4. Nehmen Sie Bearbeitungen an Ihrer Pipeline mithilfe von IntelliSense und dem Aufgaben-Assistenten vor.

    YAML-Pipeline-Editor

  1. Wählen Sie Speichern aus. Sie können einen Commit direkt in den Branch ausführen oder einen neuen Branch erstellen und optional einen Pull Request starten.

    Fenster „Speichern“ im YAML-Pipeline-Editor

Verwenden von Tastenkombinationen

Der YAML-Pipeline-Editor stellt die folgenden Tastenkombinationen bereit:

  • Drücken Sie STRG+LEERTASTE, um beim Bearbeiten der YAML-Pipeline IntelliSense-Unterstützung zu erhalten.

    IntelliSense-Unterstützung im YAML-Pipeline-Editor

  • Drücken Sie F1 (Fn+F1 unter Mac), um die Befehlspalette und die verfügbaren Tastenkombinationen anzuzeigen.

    Befehlspalette im YAML-Pipeline-Editor

Verwenden des Aufgaben-Assistenten

Mit dem Aufgaben-Assistenten können Sie Ihrer YAML-Pipeline Aufgaben hinzufügen.

  • Klicken Sie während der Bearbeitung Ihrer YAML-Pipeline auf Assistenten anzeigen, um den Aufgaben-Assistenten anzuzeigen.

    Anzeigen des Aufgaben-Assistenten bei der Bearbeitung von YAML-Pipelines

  • Klicken Sie auf Assistenten ausblenden, um den Aufgaben-Assistenten auszublenden.

    Ausblenden des Aufgaben-Assistenten bei der Bearbeitung von YAML-Pipelines

  • Durchsuchen Sie die Aufgaben im Bereich Aufgaben, oder verwenden Sie das Suchfeld, um den Aufgaben-Assistenten zu nutzen.

    Suchen nach Aufgaben mit dem Aufgaben-Assistenten

  • Wählen Sie die gewünschte Aufgabe aus, und konfigurieren Sie die Eingaben.

    Hinzufügen einer Aufgabe mit dem Aufgaben-Assistenten

  • Klicken Sie auf Hinzufügen, um Ihrer Pipeline den YAML-Code für die Aufgabe hinzuzufügen.

Hinzugefügter Aufgaben-Assistent in Azure DevOps Server 2019

  • Bearbeiten Sie den eingefügten YAML-Code, wenn Sie weitere Konfigurationsänderungen an der Aufgabe vornehmen möchten.

Hinzugefügter Aufgaben-Assistent

  • Sie können den YAML-Code bearbeiten, um weitere Konfigurationsänderungen an der Aufgabe vorzunehmen. Alternativ klicken Sie im YAML-Pipeline-Editor oberhalb der Aufgabe auf Einstellungen, um die eingefügte Aufgabe im Aufgaben-Assistenten zu konfigurieren.

Überprüfen

Überprüfen Sie Ihre Änderungen auf Syntaxfehler, die möglicherweise das Starten Ihrer Pipeline verhindern. Klicken Sie auf Weitere Aktionen>Überprüfen.

Optionen „Überprüfen“ und „YAML vollständig herunterladen“

Vollständiges Herunterladen von YAML

Sie können eine Vorschau des vollständig analysierten YAML-Dokuments anzeigen, ohne einen Commit oder die Pipeline auszuführen. Klicken Sie auf Weitere Aktionen>YAML vollständig herunterladen.

Optionen „Überprüfen“ und „YAML vollständig herunterladen“

Mit der Option YAML vollständig herunterladen wird die Azure DevOps-REST-API für Azure Pipelines ausgeführt und das Herunterladen des gerenderten YAML-Codes aus dem Editor initiiert.

Verwalten von Pipelinevariablen

Sie können Pipelinevariablen sowohl innerhalb der YAML-Pipeline als auch über die Benutzeroberfläche für die Pipelineeinstellungen verwalten.

Mit Azure DevOps 2019 Update 1 können Sie die Pipelinevariablen über die Benutzeroberfläche für die Pipelineeinstellungen verwalten.

Führen Sie die folgenden Schritte aus, um die Pipelinevariablen zu verwalten:

  1. Klicken Sie beim Bearbeiten der YAML-Pipeline auf Variablen, um die Pipelinevariablen zu verwalten.

    Schaltfläche zum Verwalten der Pipelinevariablen

  2. Wählen Sie eine der folgenden Funktionen aus:

    • Neue Variable: Fügt die erste Variable hinzu.
    • Hinzufügen: Fügt weitere Variablen hinzu.
    • Variablenname: Bearbeitet eine Variable.
    • Löschen: Löscht eine Variable.

    Verwalten von Pipelinevariablen im YAML-Editor

Führen Sie die folgenden Schritte aus, um Pipelinevariablen auf der Benutzeroberfläche für Pipelineeinstellungen zu verwalten.

  1. Klicken Sie beim Bearbeiten der Pipeline auf Weitere Aktionen>Trigger.

    Menü der Benutzeroberfläche für die Pipelineeinstellungen

  2. Klicken Sie auf Variablen.

    Option „Variablen“ in der Benutzeroberfläche für die Pipelineeinstellungen

Weitere Informationen zum Arbeiten mit Pipelinevariablen finden Sie unter Definieren von Variablen.

Konfigurieren des Standard-Agentpools

Wenn eine YAML-Pipeline keinen Agentpool angibt, wird der in der Einstellung Standard-Agentpool für YAML konfigurierte Agentpool verwendet. Dieser Pool wird auch für Bereinigungsaufgaben nach der Ausführung verwendet.

So zeigen Sie die Einstellung Standard-Agentpool für YAML an und konfigurieren sie:

  1. Klicken Sie beim Bearbeiten der Pipeline auf Weitere Aktionen>Trigger.

    Screenshot des Menüs der Benutzeroberfläche für Pipelineeinstellungen.

  2. Wählen Sie YAML aus, und wählen Sie den gewünschten Agentpool mithilfe der Dropdownliste Standard-Agentpool für YAML aus.

    Screenshot des Standard-Agentpools für YAML-Pipelines.

Der Standard-Agentpool für YAML wird auf Pipelinebasis konfiguriert.

Verwalten von Einstellungen über die Benutzeroberfläche für Pipelineeinstellungen

Einige YAML-Pipelineeinstellungen werden nicht in der YAML-Datei, sondern über die Benutzeroberfläche für Pipelineeinstellungen konfiguriert.

  1. Klicken Sie beim Bearbeiten der Pipeline auf Weitere Aktionen>Trigger.

    Screenshot des Menüs der Benutzeroberfläche für Pipelineeinstellungen.

  2. Wählen Sie auf der Benutzeroberfläche der Pipelineeinstellungen die Registerkarte der zu konfigurierenden Einstellung aus.

    Screenshot der Benutzeroberfläche für Pipelineeinstellungen für Trigger.

Anzeigen und Bearbeiten von Vorlagen

Vorlagen sind ein häufig verwendetes Feature in YAML-Pipelines. Sie sind eine einfache Möglichkeit zur Freigabe von Pipelineausschnitten und ein leistungsstarker Mechanismus zum Überprüfen und Erzwingen der Sicherheit und Governance in Ihrer Pipeline. Da Vorlagen bisher im Editor nicht unterstützt wurden, konnten Autor*innen von YAML-Pipelines keine IntelliSense-Unterstützung erhalten. Jetzt unterstützt Azure Pipelines einen YAML-Editor, der in der Vorschauversion bereitgestellt wird. Wechseln Sie zum Aktivieren der Vorschau zu den Vorschaufeatures in Ihrer Azure DevOps-Organisation, und aktivieren Sie den YAML-Vorlagen-Editor.

Wichtig

Für dieses Feature gelten die folgenden Einschränkungen:

  • Erfordert die Vorlage Parameter, die in der YAML-Hauptdatei nicht als Eingaben bereitgestellt werden, tritt bei der Überprüfung ein Fehler auf, und Sie werden zur Eingabe dieser Parameter aufgefordert.

  • Sie können im Editor keine neue Vorlage erstellen. Sie können nur vorhandene Vorlagen verwenden oder bearbeiten.

Beim Bearbeiten der YAML-Hauptdatei in Azure Pipelines können Sie eine Vorlage entweder einschließen oder erweitern. Bei der Eingabe des Vorlagennamens werden Sie möglicherweise dazu aufgefordert, Ihre Vorlage zu überprüfen. Nach der Überprüfung erkennt der YAML-Editor das Schema der Vorlage, einschließlich der Eingabeparameter.

YAML-Vorlage

Nach der Überprüfung können Sie zur Vorlage wechseln, indem Sie auf Vorlage anzeigen klicken. Dadurch wird die Vorlage in einer neuen Browserregisterkarte geöffnet, und Sie können die Vorlage mithilfe aller Features des YAML-Editors ändern.

Nächste Schritte