如何在Jenkins Groovy的sh()函数中完整捕获git tag命令输出？

问题描述 #

我希望通过Jenkins/Groovy的sh()函数执行git tag --list '<pattern>'命令，获取匹配指定模式的git标签列表。但尝试多种方式后，始终只能获取该命令输出的最后一项；而使用sh()执行ls命令时，却能正常获取全部输出。

尝试过的写法 #

1. 基础写法：

sh(
   script: "git tag --list '${pattern}*'",
   returnStdout: true
   )

无论是否使用readLines()，输出都只有最后一项。

2. 指定按行输出：

sh(
   // print all items on one row instead of columns
   script: "git tag --list '${pattern}*' --column=row",
   returnStdout: true
   )

同样无论是否使用readLines()，仅能获取最后一项。

3. 管道处理输出：

sh(
   // pipe output to remove spaces and add in comma
   script: "git tag --list '${pattern}*' | tr [:space:] ','",
   returnStdout: true
   )

结果依然只能获取最后一项。

这些git命令在本地执行时都能得到预期的完整输出，但在Jenkins中却始终只能捕获最后一项。我怀疑忽略了git命令的某些特性，请问这是什么原因？如何才能获取全部标签项？

问题原因与解决方案 #

原因 #

Jenkins的sh()函数处理git命令输出时，通常是以下问题导致的：

• 换行符差异：如果Jenkins节点是Windows环境，git输出用\r\n作为换行符，而Groovy默认按\n分割，会把所有标签识别为单行，最终只保留最后一个标签。
• 引号转义问题：变量pattern插值时，单引号包裹的模式在Shell中可能被错误解析，导致实际匹配到的标签数量异常。
• 旧版git兼容性：部分旧版本git的--list命令输出格式存在bug，会导致输出不完整。

解决方案 #

1. 先验证输出完整性
   把git命令输出写入文件，确认Jenkins环境下是否真的能输出所有标签：

sh "git tag --list \"${pattern}*\" > tags.txt"
def fullTags = readFile('tags.txt').trim()
println "完整输出：${fullTags}"

2. 兼容换行符分割标签
   用正则匹配\r\n或\n来分割输出，确保所有标签被提取：

def tagsOutput = sh(
    script: "git tag --list \"${pattern}*\"",
    returnStdout: true
).trim()
def tagsList = tagsOutput.split(/\r?\n/).findAll { it != '' }
// 遍历输出所有标签
tagsList.each { println "标签：${it}" }

3. 使用空分隔符模式（最可靠）
   git的-z参数会用空字符\0分隔标签，彻底避免换行符和空格的干扰：

def tagsOutput = sh(
    script: "git tag --list -z \"${pattern}*\"",
    returnStdout: true
)
def tagsList = tagsOutput.split('\0').findAll { it.trim() != '' }

4. 检查并升级git版本
   在Jenkins节点执行git --version，如果版本低于2.10.0，建议升级到较新版本，修复旧版本的输出格式问题。

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