YAML 管道编辑器

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

Azure Pipelines 提供了一个 YAML 管道编辑器,可用于创作和编辑管道。 YAML 编辑器基于 Monaco 编辑器。 编辑器提供 Intellisense 支持等工具和任务助手,用于在编辑管道时提供指导。

重要

YAML 管道编辑器是在 Azure DevOps Server 2019 Update 1 中引入的。 如果使用 Azure DevOps Server 2019 RTW,则本文中所述的 YAML 管道编辑器不可用,但你可以使用所选的文本编辑器编辑 YAML 并将其签入管道的存储库。

编辑 YAML 管道

若要访问 YAML 管道编辑器,请执行以下步骤。

  1. (https://dev.azure.com/{yourorganization}) 登录到组织。

  2. 选择项目,选择 “管道>管道”,然后选择要编辑的管道。

    azure Pipelines 在 Azure DevOps Server 2019 Update 1 中生成。

  3. 选择“编辑” 。

    Azure DevOps Server 2019 Update 1 中的 Azure Pipelines YAML 编辑按钮。

  4. 使用 Intellisense 键盘快捷方式和 任务助手 对管道进行编辑以获取指导。

    Azure DevOps Server 2019.1 中的 YAML 管道编辑器。

若要访问 YAML 管道编辑器,请执行以下步骤。

  1. (https://dev.azure.com/{yourorganization}) 登录到组织。

  2. 选择项目,选择 “管道”,然后选择要编辑的管道。 可以按“最近”、“全部”和“运行”浏览管道。 有关详细信息,请参阅 Pipelines 登陆页

    Azure Pipelines 登陆页。

  3. 选择“编辑” 。

    Azure Pipelines YAML 编辑按钮。

  4. 使用 Intellisense任务助手 对管道进行编辑,以获取指导。

    YAML 管道编辑器。

  1. 选择 “保存” 。 可以直接提交到分支,或创建新分支并选择性地启动拉取请求。

    YAML 管道编辑器保存窗口。

使用键盘快捷键

YAML 管道编辑器提供了几个键盘快捷方式,我们在以下示例中演示了这些快捷方式。

  • 编辑 YAML 管道时,选择 Ctrl+空格 键以获取 Intellisense 支持。

    YAML 管道编辑器 Intellisense。

  • 在 Mac) 上选择 F1 (Fn+F1 以显示命令面板并查看可用的键盘快捷方式。

    YAML 管道编辑器命令面板。

使用任务助手

任务助手提供了一种用于将任务添加到 YAML 管道的方法。

  • 若要显示任务助手,请编辑 YAML 管道,然后选择 “显示助手”。

    显示用于编辑 YAML 管道的 ask 助手。

  • 若要隐藏任务助手,请选择 “隐藏助手”。

    隐藏用于编辑 YAML 管道的任务助手。

  • 若要使用任务助手,请在“任务”窗格中浏览或搜索 任务

    任务助手搜索。

  • 选择所需任务并配置其输入。

    任务助手添加。

  • 选择 “添加” ,将任务 YAML 插入管道。

Azure DevOps Server 2019 中添加了任务助手。

  • 编辑插入的 YAML 以对任务进行更多配置更改。

添加了任务助手。

  • 可以编辑 YAML 以对任务进行更多配置更改,也可以在 YAML 管道编辑器中选择任务上方 的“设置” ,在任务助手中配置插入的任务。

验证

验证更改以捕获管道中阻止其启动的语法错误。 选择 “更多操作>验证”。

验证并下载完整的 YAML。

下载完整的 YAML

无需提交或运行管道即可 预览完全分析的 YAML 文档 。 选择“ 更多操作>”“下载完整的 YAML”。

验证并下载完整的 YAML。

下载完整 YAML运行 适用于 Azure Pipelines 的 Azure DevOps REST API,并从编辑器中启动呈现的 YAML 的下载。

管理管道变量

可以从 YAML 管道内和管道设置 UI 管理管道变量。

使用 Azure DevOps 2019 Update 1,可以使用管道设置 UI 管理管道变量。

YAML 管道

若要管理管道变量,请执行以下步骤。

  1. 编辑 YAML 管道,然后选择 “变量” 以管理管道变量。

    “管理管道变量”按钮。

  2. 从以下函数中进行选择:

    • 新变量:添加第一个变量。
    • 添加 :添加后续变量。
    • 用于编辑变量 的变量名称。
    • 删除 :删除变量。

    在 YAML 编辑器中管理管道变量。

管道设置 UI

若要在 UI 中管理管道变量,请执行以下步骤。

  1. 编辑管道,然后选择“ 更多操作>”“触发器”。

    管道设置 UI 菜单。

  2. 选择 “变量”。

    变量的管道设置 UI。

有关使用管道变量的详细信息,请参阅 定义变量

查看和编辑模板

模板 是 YAML 管道中常用的功能。 它们是共享管道代码片段的一种简单方法,是验证和强制实施管道 中安全性和治理 的强大机制。 以前,编辑器不支持模板,因此 YAML 管道的作者无法获得 Intellisense 帮助。 现在,Azure Pipelines 支持 YAML 编辑器,我们正在预览其支持。 若要启用此预览版,请转到 Azure DevOps 组织中的 预览功能 ,并启用 YAML 模板编辑器

重要

此功能具有以下限制。

  • 如果模板具有未在主 YAML 文件中作为输入提供的必需参数,则验证将失败并提示你提供这些输入。

*无法从编辑器创建新模板。 只能使用或编辑现有模板。

编辑主 Azure Pipelines YAML 文件时,可以 包含扩展 模板。 输入模板名称时,系统可能会提示验证模板。 验证后,YAML 编辑器将了解模板的架构,包括输入参数。

YAML 模板。

验证后,可以通过选择“ 查看模板”进入模板,这会在新的浏览器选项卡中打开模板。可以使用 YAML 编辑器的所有功能对模板进行更改。

后续步骤