ADO YAML 模板 - 如何处理少量平台相关任务？

Question

我正在将一些现有的经典 ADO 管道移植到 YAML。有两个独立的经典管道用于 Windows 和 Linux，但是，因为我已经能够将大多数脚本切换到bash ，所以我接近拥有一个通用的跨平台YAML 管道。

尽管如此，我仍然有一些平台相关的任务散布在大多数平台无关的任务之间。 在这几个任务中，有些只需要在 Windows 上运行，而对于 Linux 则不存在，其余存在于两个特定于平台的任务版本中 - 一个使用 bash，另一个批处理或 PowerShell。

我希望将大部分脚本制作成带有isWindows参数的模板，并使用此参数来控制与平台相关的部分。 这大致就是我所拥有的，但它不起作用：

trigger: none

pool:
  name: BuildPool
  demands:
  - Agent.OS -equals Windows_NT

extends:
  template: common-template.yml
  parameters:
    isWindows: true

然后common-template.yml本身。 请注意，此处使用condition的方法不起作用。 虽然我省略了大部分跨平台任务，但它们构成了管道的大部分——只有少数任务需要特殊处理。

parameters:
- name: isWindows
  type: boolean

jobs:
- job: MyJob

  steps:
  - checkout: none
    clean: true

  # Simple example of cross-platform script task
  - bash: |
      env
    displayName: Print Environment

  # ... more cross platform tasks

  # Windows only task
  - task: CmdLine@2
    condition: eq('${{ parameters.isWindows }}', 'true')
    inputs:
      filename: scripts\windows_only.bat

  # ... more cross platform tasks

  # Task with specialization for each platform
  # WINDOWS version
  - task: CmdLine@2
    condition: eq('${{ parameters.isWindows }}', 'true')
    inputs:
      filename: scripts\task_a.bat
  # LINUX version
  - task: Bash@3
    condition: eq('${{ parameters.isWindows }}', 'false')
    inputs:
      filePath: scripts/task_a.sh

  # ... more cross platform tasks

问题是，当我尝试使用 Linux 代理运行时，出现此错误：

No agent found in pool <pool name> satisfies both of the following demands: Agent.OS, Cmd. All demands: Agent.OS -equals Linux, Cmd, Agent.Version...

我认为这是因为CmdLine任务存在，即使它们通过condition被“关闭”。 我假设对任务的依赖可能是在评估条件之前确定的。

我正在尝试做的事情可能吗？ 还有另一种方法吗？ 我对 ADO 不是很有经验，这是我第一次尝试使用模板，所以我可能会遗漏一些简单的东西。

Answer 1

您可以使用PowerShell 步骤代替 batch/bash（PowerShell 可以安装在 Windows 和 Linux 上）。

您还可以删除需求，只在您的条件中使用预定义的Agent.OS变量来执行需要特定操作系统的任务：

- powershell: 'scripts/windows_only.ps1'
  condition: eq(variables['Agent.OS', 'Windows_NT')

Answer 2

在深入研究 ADO 文档后，我发现我需要的是条件插入：

parameters:
- name: isWindows
  type: boolean

jobs:
- job: MyJob

  ...

  # Windows only task
  - ${{ if parameters.isWindows }}:
    - task: CmdLine@2
      inputs:
        filename: scripts\windows_only.bat

  # Task with specialization for each platform
  - ${{ if parameters.isWindows }}:
    # WINDOWS version
    - task: CmdLine@2
      inputs:
        filename: scripts\task_a.bat
  - $ {{ else }}:
    # LINUX version
    - task: Bash@3
      inputs:
        filePath: scripts/task_a.sh

  ...

有一些棘手的事情可能值得强调：

1. “条件”充当 YAML 任务列表中的项目。 因此需要在前面加上- 。
2. 然后，受条件保护的实际任务相对于条件行进一步缩进。
3. 不要忘记条件末尾的冒号。
4. 我上面显示的语法实际上对我不起作用 - 我在使用else遇到错误。 事实证明， else语法是 ADO 2022 版本的一个功能，我们停留在 2020 版本上。 所以在我的例子中，我不得不引入反向测试： ${{ if not(parameters.isWindows) }}:
5. 我对如何测试真值感到很困惑。 文档中的各种示例在讨论任务condition字段中的表达式时，使用如下语法： condition: eq(variables.isSomeCondition, 'true') 。 注意与字符串值的比较。 我最初在包含表达式中复制了它，但发现${{ if eq(parameters.isWindows, 'true') }}:和${{ if eq(parameters.isWindows, 'false') }}:在参数本身是true 。 显然，在此上下文中，字符串'true'和'false'计算结果为 boolean true 。 这并不是说这没有意义——而是与记录的condition语法示例不一致让我感到困惑。