基于MR titile自动生成CHANGELOG

125 阅读1分钟

背景

目前虽然有很多基于commit自动生成CHANGELOG的工具(如git-chlog),但目前我们的commit基本都是英文的,基于英文的commit生成的CHANGELOG其实并不能完全说明我们都做了什么改动,这个时候就有了另外一个思路,那就是MR的title,MR的title对于Gitlab来说是可以随意定制的,甚至可以很方便的变更,我们可以定义一个MR规范,让大家使用中文概述改动,这样我们生成的CHANGELOG就会更加清晰

项目地址

github.com/lwydyby/mr-…

使用说明

USAGE:
  mr-chglog [options] <tag query>

    There are the following specification methods for <tag query>.

    1. <old>..<new> - MR contained in <old> tags from <new>.
    2. <name>..     - MR from the <name> to the latest tag.
    3. ..<name>     - MR from the oldest tag to <name>.
    4. <name>       - MR contained in <name>.

直接创建新的tag

mr-chglog --next-tag v0.1.6

TODO LIST

  • 支持更丰富的模板
  • 支持解析MR的描述,更完善的CHANGELOG
  • 直接将MR Diff发送给Chatgpt(或者其他AI) 生成更准确的CHANGELOG(基于poe-api)
  • 支持自动生成TAG 并上传CHANGELOG