GitLab流水线中保留JSON换行以生成MR注释的问题

方法1：用jq的--arg参数正确传递转义后的内容 #

先对$delta中的特殊字符做转义（双引号转\"，换行转\\n），再通过jq的--arg参数传入，让jq自动处理JSON格式，避免手动拼接的错误：

# 转义delta里的双引号和换行符
escaped_delta=$(printf '%s' "$delta" | sed -e 's/"/\\"/g' -e 's/\n/\\n/g')

# 调用GitLab API提交注释
curl --request POST "$GITLAB_API_MR_NOTES_URL" \
  --header "PRIVATE-TOKEN: $GITLAB_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data "$(jq -n --arg note_body "$escaped_delta" '{body: $note_body}')"

方法2：用curl的--data-binary结合 heredoc 传递原始内容 #

跳过jq，直接用--data-binary保留原始换行，仅转义双引号保证JSON语法合法：

curl --request POST "$GITLAB_API_MR_NOTES_URL" \
  --header "PRIVATE-TOKEN: $GITLAB_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data-binary @- <<EOF
{"body": "$(printf '%s' "$delta" | sed -e 's/"/\\"/g')"}
EOF

--data-binary会完整保留输入的换行符，不需要额外转义换行，只需要处理双引号避免JSON结构破裂。

方法3：在Python脚本中直接完成API请求 #

既然已经用Python脚本生成delta，直接在Python里构造JSON并调用API，彻底避开Bash的转义坑：

import requests
import json

# 替换为实际的变量值
delta = "你的代码尺寸对比结果（带原始换行）"
gitlab_token = "你的GitLab访问令牌"
api_url = "https://your-gitlab-instance/api/v4/projects/<项目ID>/merge_requests/<MR编号>/notes"

payload = {"body": delta}
headers = {
    "PRIVATE-TOKEN": gitlab_token,
    "Content-Type": "application/json"
}

requests.post(api_url, headers=headers, data=json.dumps(payload))

Python的json.dumps会自动处理字符串中的换行、引号等特殊字符，完全不需要手动转义，是最稳定的方案。

之前方案失败的常见原因 #

• 手动拼接JSON时未正确转义双引号，导致JSON语法错误，API解析时直接丢弃异常内容；
• 用--data而非--data-binary时，curl会自动将换行转换为空格；
• 直接用jq拼接未转义的字符串，jq会把换行识别为JSON结构的分隔符，导致内容被截断。

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