如何在 azure DevOps YAML 管道中发送构建后消息？

Question

我正在尝试在 Azure DevOps YAML 管道中完成/失败后发送构建后 Slack 消息。但似乎我找不到合适的条件设置。

基本上，我分为三个阶段：测试、构建和通知。

我最后尝试了以下方法，但 dependencies.UnitTest.result 返回 null，所以没有给我 Succeeded 或 Failed。

我也尝试了很多不同的条件，但都没有奏效。例如，没有依赖关系的普通 succeeded() 和 failed()，或 succeeded('Test') 作为阶段级别或 succeeded('UnitTest') 作为作业级别。

在大多数情况下，即使在测试阶段失败，它们也会发送成功消息，或者将作业名称作为 succeeded() 或 failed() 中的参数的语法错误

像 Jenkins 这样发送构建后消息的合适条件是什么？

stages:
- stage: Test
  jobs:
  - job: UnitTest
    steps:
    - script: echo UnitTest
    - script: exit 1

- stage: Build
  jobs:
  - job: Build
    steps:
    - script: echo Build

- stage: Notify
  dependsOn:
  - Test
  - Build

  condition: succeededOrFailed()
  jobs:
  - job: Succeed
    condition: eq(dependencies.UnitTest.result, 'Succeeded')
    steps:
    - script: echo Succeed #(slack)

  - job: Fail
    condition: eq(dependencies.UnitTest.result, 'Failed')
    steps:
    - script: echo Fail #(slack)

--- 编辑 ---
MS 支持多阶段确认的作业，不能作为 yaml 语法本身支持。

与预期的原始流程不同，但您可以将成功和失败分为不同的阶段，如下所示。 （如果你想为每个作业提供不同的消息，它可能会增加相当多的阶段，只是为了通知..）

...

- stage: Notify_Succeeded
  condition: succeeded()

  jobs:
  - job: Succeed
    steps:
    - script: echo Succeed #(slack)

- stage: Notify_Fail
  condition: failed()
  jobs:
  - job: Fail
    steps:
    - script: echo Fail #(slack)

Answer 1

这是可能的，但您必须使用 REST API。使用以下 YAML，您将获得您所描述的内容：

variables:
  orgName: 'thecodemanual'

stages:
- stage: Test
  jobs:
  - job: UnitTest
    steps:
    - script: echo UnitTest
    - script: exit 1

- stage: Build
  jobs:
  - job: Build
    steps:
    - script: echo Build

- stage: Notify
  dependsOn:
  - Test
  - Build

  condition: succeededOrFailed()
  jobs:
  - job: InitialJob
    condition: always()
    steps:
    - pwsh: |
        $url = "https://dev.azure.com/$(orgName)/$(System.TeamProject)/_apis/build/builds/$(Build.BuildId)/timeline?api-version=5.1"
        $timeline = Invoke-RestMethod -Uri $url -Headers @{Authorization = "Bearer $env:SYSTEM_ACCESSTOKEN"}
        Write-Host "Pipeline = $($timeline | ConvertTo-Json -Depth 100)"

        $test = $timeline.records | where { $_.identifier -eq "Test.UnitTest" }

        $result = $test.result

        Write-Host "##vso[task.setvariable variable=testResult;isOutput=true]$result"
      name: initial
      env:
        SYSTEM_ACCESSTOKEN: $(system.accesstoken)

  - job: Succeed
    dependsOn: InitialJob
    condition: eq(dependencies.InitialJob.outputs['initial.testResult'], 'succeeded')
    steps:
    - script: echo Succeed #(slack)

  - job: Fail
    dependsOn: InitialJob
    condition: eq(dependencies.InitialJob.outputs['initial.testResult'], 'failed')
    steps:
    - script: echo Fail #(slack)

让我解释一下我在上面做了什么：

• 我调用了 REST API 以获取上一阶段的步骤结果（因为目前无法获取任务结果）
• 我将该步骤的状态分配给输出变量
• 我使用这个变量作为条件来运行特定的作业Succeed 或Fail

备注：在运行代码之前，请将orgName更改为您的。

编辑

下面的 url 返回您构建的详细信息。但是您不会在那里获得有关特定任务或阶段的信息。但是你会得到一个时间轴的 url。

https://dev.azure.com/$(orgName)/$(System.TeamProject)/_apis/build/builds/$(Build.BuildId)?api-version=5.1

此 REST 端点将为您返回一个时间表，其中包括任务和阶段的详细信息。

https://dev.azure.com/$(orgName)/$(System.TeamProject)/_apis/build/builds/$(Build.BuildId)/timeline?api-version=5.1

Answer 2

您可以指定每个阶段运行的条件。默认情况下，如果一个阶段不依赖于任何其他阶段，或者它所依赖的所有阶段都已完成并成功，则该阶段会运行。

根据运行前一个阶段的状态运行阶段的示例：

stages:
- stage: A

# stage B runs if A fails
- stage: B
  condition: failed()

# stage C runs if B succeeds
- stage: C
  dependsOn:
  - A
  - B
  condition: succeeded('B')

使用自定义条件的示例：

stages:
- stage: A

- stage: B
  condition: and(succeeded(), eq(variables['build.sourceBranch'], 'refs/heads/master'))

注意：您目前无法指定基于前一阶段中设置的输出变量的值运行阶段。

文档：

https://docs.microsoft.com/en-us/azure/devops/pipelines/process/stages?view=azure-devops&tabs=yaml#conditions