GitLab CI中使用yq更新YAML文件时出现语法错误的问题

问题情况 #

在GitLab CI里执行命令，想在打包推送Helm Chart前更新values.yaml里的pod.image.imageTag字段，第一次用的命令是：

yq -i -y ".pod.image.imageTag="${CI_COMMIT_SHORT_SHA}"" deployment/values.yaml

你的values.yaml内容是：

pod:
  image:
    repository: my.private.repo/my-project
    imageTag: 'latest'
  nodegroupName: "nessie-nodegroup"

执行后一直报这个错：

jq: error: syntax error, unexpected IDENT, expecting $end (Unix shell quoting issues?)
.pod.image.imageTag=4c0118bf  

能看到CI_COMMIT_SHORT_SHA变量已经读到了（错误里的4c0118bf就是这个值），但命令始终有问题，你试了下面两种写法也没解决：

yq -i -y '.pod.image.imageTag="${CI_COMMIT_SHORT_SHA}"' deployment/values.yaml

yq -i -y .pod.image.imageTag="${CI_COMMIT_SHORT_SHA}" deployment/values.yaml

错误原因 #

1. 引号和语法格式错误
   你第一次的命令里，.pod.image.imageTag="${CI_COMMIT_SHORT_SHA}"被shell解析后，直接变成了.pod.image.imageTag=4c0118bf——这里赋值的地方没有加空格，而你用的yq是基于jq的版本（从错误提示里的jq就能看出来），这种yq要求赋值必须写成key = value的格式，没有空格的key=value属于无效语法，直接触发jq的语法错误。

2. 变量展开和引号冲突
   第二种写法用单引号把整个表达式包起来了，shell不会解析单引号里的变量，最后写入的就是字符串"${CI_COMMIT_SHORT_SHA}"，不是实际的commit哈希；第三种写法没给表达式加引号，shell解析后整个命令的语法彻底乱了，自然也跑不通。

正确的命令写法 #

如果你用的是基于jq的kislyuk/yq，用下面两种写法都可以：

# 单引号拼接变量的写法
yq -i -y '.pod.image.imageTag = "'"${CI_COMMIT_SHORT_SHA}"'"' deployment/values.yaml
# 双引号转义内部引号的写法
yq -i -y ".pod.image.imageTag = \"${CI_COMMIT_SHORT_SHA}\"" deployment/values.yaml

要是你用的是更流行的mikefarah/yq v4及以上版本，还可以直接用环境变量读取的语法：

yq -i '.pod.image.imageTag = env(CI_COMMIT_SHORT_SHA)' deployment/values.yaml

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