Azure DevOps环境页面如何显示动态设置的构建名称？

问题描述 #

我有一条部署到Azure DevOps指定环境的YAML流水线，希望通过环境页面快速查看各环境当前部署的版本。默认情况下环境页面只显示构建ID，无法直观识别部署内容。

如果在YAML中设置静态自定义名称，环境页面能正常显示该名称：

name: "Example of a name"

但如果通过脚本从关联的构建流水线资源中获取名称并动态更新构建号后，构建页面能正确显示新名称，环境页面却依然显示标准构建ID：

BuildName=$(resources.pipeline.BuildResource.runName)
echo "##vso[build.updatebuildnumber]$BuildName"

解决方案 #

1. 在YAML开头直接动态设置name字段 #

无需通过脚本运行时更新，直接在流水线定义的name中引用资源变量，让流水线初始化时就生成带版本信息的构建名称，环境页面会直接读取这个值：

name: $(resources.pipeline.BuildResource.runName)

resources:
  pipelines:
  - pipeline: BuildResource
    source: 你的构建流水线名称
    trigger:
      branches:
        include:
        - main

stages:
- stage: Deploy
  jobs:
  - deployment: DeployToEnv
    environment: 你的环境名称
    steps:
    - script: echo "Deploying version $(Build.BuildNumber)"

2. 给环境部署添加版本标签 #

如果必须用脚本更新构建号，可以同时给环境的部署记录添加自定义标签，标签会显示在环境页面的部署记录中，方便快速识别版本：

BuildName=$(resources.pipeline.BuildResource.runName)
# 更新构建号
echo "##vso[build.updatebuildnumber]$BuildName"
# 给环境添加版本标签
echo "##vso[environment.addtag]Version:${BuildName}"

3. 自定义部署作业的显示名称 #

在部署作业中设置包含动态版本号的displayName，环境页面会显示这个作业名称，也能直观识别当前部署的版本：

jobs:
- deployment: DeployToEnv
  displayName: 'Deploy $(resources.pipeline.BuildResource.runName) to 你的环境名称'
  environment: 你的环境名称
  steps:
  - script: echo "Deploying..."

原因说明 #

Azure DevOps的环境页面在部署触发时就会抓取构建的初始标识（ID/名称），而通过##vso[build.updatebuildnumber]在运行时更新的构建号，不会同步到已生成的环境部署记录中，因此环境页面依然显示触发时的构建ID。

内容的提问来源于stack exchange，提问作者Matthew van Boheemen