V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
git
Pro Git
Atlassian Git Tutorial
Pro Git 简体中文翻译
GitX
x97bgt
V2EX  ›  git

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

  •  
  •   x97bgt · 2021-09-22 18:36:06 +08:00 · 4497 次点击
    这是一个创建于 918 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    13 条回复    2021-09-26 15:23:04 +08:00
    anxn
        1
    anxn  
       2021-09-22 19:34:36 +08:00 via Android
    janxin
        3
    janxin  
       2021-09-22 20:46:47 +08:00 via iPhone
    git-chglog
    zthxxx
        4
    zthxxx  
       2021-09-22 22:08:35 +08:00   ❤️ 1
    nmgwddj
        6
    nmgwddj  
       2021-09-23 11:36:08 +08:00   ❤️ 1
    我对 CHANGELOG 的存在价值持怀疑态度。commits 信息已经足够可以描述修改历史了,为什么还需要一个 CHANGELOG ?
    如果你觉得 CHANGELOG 是给不同角色的人看的,那自动生成的内容往往也不能满足需求。一个 commit 的 title 80 个字符可以描述的内容及其有限,而 commit 的 description 内容又可能会非常多,更加不适合给非程序员的角色去看。
    所以,自动生成 CHANGELOG 的意义是什么?
    flniu
        7
    flniu  
       2021-09-23 13:15:24 +08:00
    https://keepachangelog.com/zh-CN/1.0.0/
    楼上说的有道理:更新日志绝对不应该是 git 日志的堆砌物
    indo
        9
    indo  
       2021-09-23 14:24:52 +08:00
    对于我这种 commit 都经常乱打的人,表示还是自己手动写 changelog 更合适吧。
    fml87
        10
    fml87  
       2021-09-23 14:50:10 +08:00
    自动生成有意义的 changelog 的前提是 commit 信息必须严格遵照特定的规范,感觉也就个人项目这么搞的成本低一些
    learningman
        11
    learningman  
       2021-09-23 15:14:08 +08:00
    semantic-release
    liziwl
        12
    liziwl  
       2021-09-23 23:17:40 +08:00
    @fml87 确实哈哈哈哈哈,commit 或者 changelog 总要认真写一个。像我 commit 随意写的,还是老实写 changelog 好了。
    nmgwddj
        13
    nmgwddj  
       2021-09-26 15:23:04 +08:00
    @KouShuiYu 多不代表就是对的、最佳的。做技术的人更要跳出这个思维模式,要考虑做这件事情的意义和价值。这样才不会盲目跟风做一些无意义产出。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   4181 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 05:28 · PVG 13:28 · LAX 22:28 · JFK 01:28
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.