利用shell脚本生成CHANGELOG.md(包含git提交规范)

时间:2021-11-22 06:41:57

前言

我们经常看到github上面有很多CHANGELOG.MD包含版本的更新信息,如果我们的git提交能遵循一定的规范,那么使用gitlog就能很方便的生成它

生成结果

利用shell脚本生成CHANGELOG.md(包含git提交规范)

shell脚本

https://github.com/LinkinStars/springBootTemplate/blob/master/gitlog.sh

将脚本放在项目的根目录,然后给与权限,然后运行后,就能生成和上面差不多的CHANGELOG.md

git提交规范

当然如果你和上面不一样也正常,需要你git提交的message按照一定的规范,如下:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>

- type:用于说明commit的类别,规定为如下几种
-- feat (增加新功能)
-- fix (修改bug)
-- docs (文档修改)
-- style (代码格式修改)
-- refactor (重构并且不影响任何功能)
-- test (测试代码修改)
-- chore (维护相关杂项)

- scope:【可选】用于说明commit的影响范围
- subject:commit的简要说明,一句话描述这次的改动,尽量简短
- body
更新的具体细节

具体实例就和上面的图片中所示
这个规范是google上面来的,需要***
https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0

相关还有:http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

里面也有相应的工具可以生成,但是我觉得还是shell脚本好用,因为对于mac或者linux不需要任何环境依赖

PS:脚本很简单,你可以根据你的实际情况进行调整输出的格式数据等