如何在ADO中基于提交记录/工作项生成面向审批人的版本说明
发布说明信息筛选方案
不需要改动现有部署架构,可通过以下规则筛选仅需展示的信息,过滤无关提交:
- 统一提交规范,使用约定式提交规则:只有
feat:(新功能)、fix:(线上问题修复)、refactor:(核心逻辑重构)、infra:(基础设施变更)前缀的提交才会被提取到发布说明中,chore:(依赖升级、通用配置调整)、docs:(文档修改)等无关内容直接过滤。 - 特殊标记过滤:如果需要更灵活的筛选规则,可要求开发人员在需要同步到发布说明的提交末尾添加
[release-note]标记,提取脚本仅抓取带该标记的提交内容,其余全部忽略。 - 工作项维度过滤:仅同步状态为「已完成」、关联当前发布分支的工作项,过滤草稿、已取消、关联其他分支的无效工作项。
ADO PBI工作项同步方案
通过ADO内置能力+少量自定义脚本即可实现,无需调整现有部署流程:
- 关联提交与PBI:要求开发人员提交代码或提交PR时,在描述中添加
AB#PBI编号(例如AB#1234),ADO会自动将该提交/PR与对应PBI绑定,无需额外配置。 - 添加发布说明提取任务:在发布流水线最开始新增一个PowerShell任务,调用ADO官方REST API拉取当前发布关联的所有PBI,筛选需要的字段拼接为发布说明内容,示例脚本如下:
# 替换为你的组织名、项目名,其余变量为ADO流水线内置变量可直接使用 $org = "你的组织名称" $project = "你的项目名称" $url = "https://dev.azure.com/$org/$project/_apis/release/releases/$(Release.ReleaseId)/workitems?api-version=7.1-preview.1" $headers = @{Authorization = "Bearer $(System.AccessToken)"} $workItems = Invoke-RestMethod -Uri $url -Headers $headers -Method Get # 自定义拼接需要展示的PBI字段,例如标题、优先级、负责人 $releaseNoteContent = "## 本次发布关联工作项`n" foreach ($item in $workItems.value) { $releaseNoteContent += "- PBI $($item.id):$($item.fields.'System.Title'),优先级:$($item.fields.'Microsoft.VSTS.Common.Priority')`n" } # 将生成的发布说明写入流水线变量,供后续环节调用 Write-Host "##vso[task.setvariable variable=ReleaseNote;isOutput=true]$releaseNoteContent"
提前给流水线服务账号开放对应项目的工作项读取权限,避免API调用无权限。
- 审批环节展示发布说明:在基础设施、应用两个审批节点的配置中,直接引用上一步生成的
ReleaseNote变量,审批人员打开审批界面即可直接看到筛选后的发布内容,无需跳转查看其他页面。
内容的提问来源于stack exchange,提问作者Poul K. Sørensen
相关产品推荐
相关产品推荐

