有什么自动生成 CHANGELOG 的好方式吗?

2021-09-22 18:36:06 +08:00
 x97bgt

release 时的 CHANGELOG 都是手写的,每次都要找 commit 历史找到发疯。有啥好的工具可以根据 commit 生成 CHANGELOG 的么?

4801 次点击
所在节点    git
13 条回复
anxn
2021-09-22 19:34:36 +08:00
Trim21
2021-09-22 19:36:21 +08:00
janxin
2021-09-22 20:46:47 +08:00
git-chglog
zthxxx
2021-09-22 22:08:35 +08:00
KouShuiYu
2021-09-23 10:35:55 +08:00
nmgwddj
2021-09-23 11:36:08 +08:00
我对 CHANGELOG 的存在价值持怀疑态度。commits 信息已经足够可以描述修改历史了,为什么还需要一个 CHANGELOG ?
如果你觉得 CHANGELOG 是给不同角色的人看的,那自动生成的内容往往也不能满足需求。一个 commit 的 title 80 个字符可以描述的内容及其有限,而 commit 的 description 内容又可能会非常多,更加不适合给非程序员的角色去看。
所以,自动生成 CHANGELOG 的意义是什么?
flniu
2021-09-23 13:15:24 +08:00
https://keepachangelog.com/zh-CN/1.0.0/
楼上说的有道理:更新日志绝对不应该是 git 日志的堆砌物
KouShuiYu
2021-09-23 14:24:41 +08:00
indo
2021-09-23 14:24:52 +08:00
对于我这种 commit 都经常乱打的人,表示还是自己手动写 changelog 更合适吧。
fml87
2021-09-23 14:50:10 +08:00
自动生成有意义的 changelog 的前提是 commit 信息必须严格遵照特定的规范,感觉也就个人项目这么搞的成本低一些
learningman
2021-09-23 15:14:08 +08:00
semantic-release
liziwl
2021-09-23 23:17:40 +08:00
@fml87 确实哈哈哈哈哈,commit 或者 changelog 总要认真写一个。像我 commit 随意写的,还是老实写 changelog 好了。
nmgwddj
2021-09-26 15:23:04 +08:00
@KouShuiYu 多不代表就是对的、最佳的。做技术的人更要跳出这个思维模式,要考虑做这件事情的意义和价值。这样才不会盲目跟风做一些无意义产出。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/803455

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX