如何在Azure DevOps拉取请求中格式化状态检查返回内容
Azure DevOps 拉取请求状态检查描述换行实现方案
结论
需求可以实现,Azure DevOps 对拉取请求状态检查的描述字段提供有限的 Markdown 语法支持,不支持直接解析 HTML 标签。
正确换行实现方式
你之前尝试的<br/>、单独的\n/\r/\r\n都不生效是因为不符合平台的解析规则,按以下规则编写即可实现换行:
- 行内换行:在需要换行的行末尾添加两个空格,再跟上换行符
\n - 段落换行:输入两个连续的换行符(两行内容中间空一行)
除了换行外,你还可以使用基础 Markdown 格式优化展示效果,包括行内代码、斜体强调、加粗高亮、无序列表、有序列表等。
调用 REST API 示例
更新拉取请求状态时,description字段参考写法如下:
{ "state": "failed", "description": "代码准入检查未通过,请修改以下问题: \n- 公共方法缺少必要的注释说明 \n- 存在2处语法错误 \n- 单元测试覆盖率仅为62%,未达到80%的要求", "context": { "name": "自定义代码检查", "genre": "ci" } }
上述内容提交后,会在拉取请求的状态检查区域按每行一条的格式换行展示。
版本限制说明
该特性仅支持 Azure DevOps Services(云版)、Azure DevOps Server 2020 及以上版本,如果你使用的是更早的 Server 版本(如 2019 及之前),状态描述字段为纯文本,不支持格式渲染,无法实现换行效果。
内容的提问来源于stack exchange,提问作者MikeW
相关产品推荐
相关产品推荐

