如何通过Azure DevOps REST API在Azure Pipeline的PR评论中添加链接？

问题详情 #

我写了一段Azure Pipelines的代码，但无法正常运行：

parameters:
      comment: >
        {
          "comments": [
            {
              "parentCommentId": 0,
              "content": "<a href\=\"$(taskUrl)\">Click here to see colored output of Terraform plan:</a>\\n\`\`\`hcl$(plan)\`\`\`",
              "commentType": "system"
            }
          ],
          "status": "byDesign"
        }

...some template...

  curl --fail \
    --request POST "$URL" \
    --header "Authorization: Bearer ${{ parameters.accessToken }}" \
    --header "Content-Type: application/json" \
    --data @- <<- EOF
  ${{ parameters.comment }}
  EOF

推测Azure Pipelines在清理代码，检查后发现href后的内容被完全删除。尝试过Markdown格式[example](https://link.com)，但括号导致解析错误，转义后仍无效，折腾一周没找到解决方案。

解决方法 #

1. 用jq拼接JSON避免多层转义 #

Azure Pipelines对嵌套参数的转义处理会导致HTML/Markdown格式被破坏，改用jq动态生成JSON payload，自动处理特殊字符转义：

parameters:
  accessToken: ''
  taskUrl: ''
  plan: ''
  url: ''

steps:
- script: |
    # 直接编写Markdown/HTML内容，无需手动转义
    COMMENT_CONTENT='[Click here to see colored output of Terraform plan](${{ parameters.taskUrl }})
```hcl
${{ parameters.plan }}
```'
    # 用jq生成标准JSON，自动处理引号、括号转义
    PAYLOAD=$(jq -n \
      --arg content "$COMMENT_CONTENT" \
      '{
        comments: [
          {
            parentCommentId: 0,
            content: $content,
            commentType: "system"
          }
        ],
        status: "byDesign"
      }')
    # 打印payload用于调试（可选）
    echo "Generated payload: $PAYLOAD"
    # 发送POST请求
    curl --fail \
      --request POST "${{ parameters.url }}" \
      --header "Authorization: Bearer ${{ parameters.accessToken }}" \
      --header "Content-Type: application/json" \
      --data "$PAYLOAD"
  displayName: 'Post Terraform Plan Comment'

2. 优化参数传递方式 #

避免在parameters中直接嵌套复杂JSON字符串，把动态内容拆分为独立参数，在脚本层组合：

• 将taskUrl、plan单独作为参数传入，减少多层转义的冲突
• 用脚本变量存储评论内容，绕过Pipeline对参数的自动解析过滤

3. 调试技巧 #

• 在curl命令前添加echo "$PAYLOAD"，确认生成的JSON格式是否正确，参数是否被正确替换
• 用curl -v查看请求的详细内容，确认发送到API的payload是否符合要求

内容的提问来源于stack exchange，提问作者Markus Peterson