在GitLab-CI中使用jq校验JSON键存在性及值匹配异常问题

问题根源 #

真实的TRIGGER_PAYLOAD在GitLab-CI环境中会被自动处理（比如转义双引号、拆分多行），导致jq解析时出现格式错误。简单查询能执行是因为jq对局部结构的容错性高，但复合校验需要完整合规的JSON结构，所以暴露了问题。

分步解决方案 #

1. 先排查TRIGGER_PAYLOAD的真实格式 #

在CI job中先执行以下命令，查看变量的实际内容（包括转义字符、换行符）：

echo "$TRIGGER_PAYLOAD" | cat -A

输出中如果看到\"（转义的双引号）或$结尾的换行标记，就是需要处理的点。

2. 处理转义与换行问题 #

针对GitLab自动转义双引号和多行拆分的情况，用以下命令还原并解析：

# 先还原转义字符，再去除换行，最后执行复合校验
printf "%b" "$TRIGGER_PAYLOAD" | tr -d '\n' | jq '
  has("changes") and
  .changes | has("title") and
  .title | has("previous") and has("current") and
  .object_attributes.detailed_merge_status == "mergeable"
'

• printf "%b"：还原被转义的双引号等特殊字符
• tr -d '\n'：去除所有换行符，确保JSON是单行结构
• jq的复合逻辑拆分成多行，便于调试和阅读

3. 针对JSON字符串嵌套的情况 #

如果TRIGGER_PAYLOAD本身是一个被双引号包裹的JSON字符串（比如"{...}"），需要先把字符串解析为JSON对象：

echo "$TRIGGER_PAYLOAD" | jq -R 'fromjson' | jq '
  has("changes") and
  .changes.title | has("previous") and has("current") and
  .object_attributes.detailed_merge_status == "mergeable"
'

• -R：告诉jq把输入当作原始字符串处理
• fromjson：将字符串解析为JSON对象

4. 关键注意事项 #

• 必须用双引号包裹"$TRIGGER_PAYLOAD"，否则shell会把JSON中的空格当作分隔符，破坏结构
• 测试时可以把jq命令的结果赋值给变量，用于后续CI逻辑判断：

  VALID=$(printf "%b" "$TRIGGER_PAYLOAD" | tr -d '\n' | jq -r '
    has("changes") and
    .changes.title | has("previous") and has("current") and
    .object_attributes.detailed_merge_status == "mergeable"
  ')
  if [ "$VALID" = "true" ]; then
    # 执行符合条件的逻辑
  else
    # 不符合条件的处理
  fi
  

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