Jenkins 中对 Git 日志过滤

Jenkins 中想对某次构建中的 Git 的日志进行过滤后使用，首先需要拿到上次构建成功的 Git HASH 值，Jenkins 提供了这样的一条链接，可以拿到上次构建成功时的一些信息：

1

http://<host>/job/<job_name>/lastSuccessfulBuild/api/xml

可以使用 curl 拿到 XML 文件的内容：

1

curl --silent --user $USER:$API_TOKEN $URL | grep "<lastBuiltRevision>" | sed 's|.*<lastBuiltRevision>.*<SHA1>\(.*\)</SHA1>.*<branch>.*|\1|'

lastBuiltRevision 就是上次构建成功时的 Git commit 的 HASH 值，注意这条链接访问需要权限，$USR 参数是 Jenkins 用户名，$API_TOKEN 是用户密码。

Jenkins 也提供了参数给出上次构建成功时的 Git commit HASH 值，及 GIT_PREVIOUS_SUCCESSFUL_COMMIT，在执行构建时可以使用这个参数。

Git 提供了工具对日志进行格式，及 Git - pretty-formats，接下来可以拿到两个 commit 之间的 log 并进行格式化：

1

LOG=$(git log --pretty="%s" $GIT_PREVIOUS_SUCCESSFUL_COMMIT..HEAD)

HEAD 就是上一次 commit 了，由于我们只需要日志信息，不需要其他，所以只保留了 %s 占位符，这样 LOG 变量中就保存了上次构建成功到最新一次提交间的日志，一条一行。

接下来去掉不想要的 LOG，这里简单的去掉了不以 [ 开头的行：

1

CLEAN_LOG=$(echo "$LOG" | sed '/^[^\\[].*$/d')

这里有个坑，如果不用双引号包裹 $LOG 参数，则输出 $LOG 参数时会去掉换行信息，用空格隔开每一条，最终成一行，那样用 sed 命令删除行是无效的。

由于我要用在 Jenkins 邮件中，邮件是 HTML 格式的，所有我在末尾加了 <br> 标签：

1

LOG_WIHT_NEWLINE_TAG=$(echo "$CLEAN_LOG" | sed 's/$/&<br>/g')

还是用的 sed 命令，一个匹配和替换过程。

接下来翻转一下，因为通过 git log 拿到的日志是从最近一次提交到上次构建成功时的顺序，而我希望是按时间顺序来排列，所以翻转一下，还是 sed 命令：

1

FLIP_LOG=$(echo "$LOG_WIHT_NEWLINE_TAG" | sed '1!G;h;$!d')

嗯，这个命令我还不是很懂，Google 查到的，见参考资料。

在行首添加行号：

1

LOG_WITH_LINE_NUMBER=$(echo "$FLIP_LOG" | awk '{printf NR"."" "}1')

接下来需要将所有行转成一行，之前没有转是因为方便对每一行处理，这里处理基本完成了，可以转成一行方便存储，同时也因为需要使用 Envinject 注入环境变量，而变量是不能换行的，所有这里要转成一行，命令：

1

FLAT_LOG=$(echo "$LOG_WITH_LINE_NUMBER" | tr "\n" " ";echo)

由于项目使用 Jira 管理 Bug，如果把日志中的 Jira bug 替换成链接就更好了，Jira 的链接格式固定，都是 http://jira.domain.com/browse/ProjectBug-xxx ，可以对日志中的 ProjectBug-xxx 进行匹配，xxx 是数字，所以规则就是 ProjectBug- 后连续 N 个数字，使用正则匹配这一部分可以使用以下正则：

1

ProjectBUG-[0-9]\{1,\}

其实正则支持使用 + 进行连续匹配，但是在 sed 中使用 + 进行连续匹配时匹配不到内容，所以使用与 + 等效的 {1,} 进行匹配，意思为前面一规则连续 1 个到无限多个，命令如下：

1

LOG_WITH_LINK=$(echo $FLAT_LOG | sed 's/\(ProjectBug-[0-9]\{1,\}\)/<a  href="http:\/\/jira.domain.com\/browse\/\1">\1<\/a>/g')

注意规则中的 {1,} 括号要进行转义，刚开始用的时候没有转义匹配不到内容。且在替换的内容中，/ 也要进行转义，sed 使用 / 进行不同作用的区域的分割符区分。

到这里日志的处理加工就完成了，写入到参数列表中：

1

echo FILTERED_CHANGES="$(echo "$LOG_WITH_LINK")" >> build.properties

使用 >> 对文件进行追加，使用 > 进行覆盖，这里看自己情况选择就好。

按照 Jenkins 变量传递的方法设置，在之后的步骤中，就可以使用 FILTERED_CHANGES 变量了。

整个过程就是一个面向 Google 折腾的过程，由于对这些替换匹配操作都不熟，所以一步一查，可以看本篇文章那长长的参考资料列表 :( 不过最终达到了效果，还不错 :)

参考

–EOF–