在Kudu项目中使用SCM_COMMIT_MESSAGE变量处理Git提交消息的技巧

背景介绍

在Kudu项目的部署脚本(deploy.cmd)中，开发者经常需要获取Git提交信息(commit message)用于各种用途，比如发送部署通知。Kudu提供了SCM_COMMIT_MESSAGE环境变量来方便地获取这些信息。然而，直接使用这个变量可能会遇到一些特殊字符处理的问题。

问题分析

当尝试在部署脚本中使用%SCM_COMMIT_MESSAGE%变量时，特别是需要将其作为JSON数据的一部分发送到外部系统(如Microsoft Teams)时，会遇到以下问题：

1. 换行符问题：Git提交信息通常包含换行符，这些换行符会破坏脚本的执行流程
2. JSON格式要求：在构建JSON字符串时，需要将换行符转换为\n这样的转义序列
3. 脚本解析限制：批处理脚本对特殊字符的处理能力有限

解决方案比较

直接使用SCM_COMMIT_MESSAGE

直接使用环境变量的方式简单直接：

curl ... --data "{\"message\": \"%SCM_COMMIT_MESSAGE%\"}" ...

但这种方法会因提交信息中的换行符导致脚本执行中断。

使用git show命令替代

更可靠的替代方案是使用git命令直接获取并处理提交信息：

git show -s "%SCM_COMMIT_ID%" --pretty="%%%%h : %%%%s" > commitmessage.txt
SET /p COMMIT_MESSAGE=<commitmessage.txt

这种方法有以下优势：

1. 可以控制输出格式，包括缩写提交哈希(short hash)
2. 自动去除换行符等特殊字符
3. 可以灵活添加其他提交信息如作者、日期等
4. 输出结果更干净，适合嵌入JSON等结构化数据

最佳实践建议

1. 对于简单场景：如果只需要提交信息的单行摘要，优先使用git show方法
2. 需要完整信息：若确实需要保留多行信息，考虑：
   • 使用jq等工具对JSON进行预处理
   • 将提交信息进行Base64编码传输
   • 在接收端进行特殊字符处理
3. 格式控制：利用--pretty参数自定义输出格式，例如：
   • %h：缩写提交哈希
   • %s：提交主题
   • %an：作者名字
   • %cr：相对提交时间

技术原理

Git提交信息存储在commit对象中，通常包含：

1. 第一行：简短描述(通常作为主题)
2. 空行
3. 详细描述(可多行)

Kudu的SCM_COMMIT_MESSAGE变量会原样包含所有这些内容，包括换行符。而在批处理脚本中，换行符会被解释为命令分隔符，导致脚本解析错误。

通过git show命令配合重定向操作，可以有效地规避这个问题，因为：

1. SET /p命令读取文件时会自动处理换行符
2. 输出重定向到文件时，特殊字符被保留而不被解释
3. 可以精确控制输出的内容和格式

总结

在Kudu部署脚本中处理Git提交信息时，虽然SCM_COMMIT_MESSAGE变量提供了便利的直接访问方式，但在实际应用中可能会遇到特殊字符处理的问题。采用git show命令结合文件重定向的方法提供了更可靠、更灵活的解决方案，特别是在需要将提交信息嵌入结构化数据(如JSON)或发送到外部系统的场景中。开发者应根据具体需求选择合适的方法，并注意对特殊字符进行适当处理。