nbc-auto-changelog

v1.1.2

2 months ago

一键生成 CHANGELOG.md 工具，基于开源项目 auto-changelog

用于从 git 标签和提交历史生成更改日志的命令行工具

修改自 auto-changelog

安装

npm -g install nbc-auto-changelog  // 全局使用

或者

npm install nbc-auto-changelog -D  // 作为开发环境依赖使用

最基本的使用方法

首先编辑 package.json，加入 version 运行脚本命令

{
    "scripts": {
      "version": "nbc-auto-changelog -p && git add CHANGELOG.md"
    }
}

最后终端输入

npm version [新版本号]

就可以实现 package.json 里的 version 版本自动更新，然后 CHANGELOG.md 会自动生成，并为当新版本 version 生成一个新 标签(tag)

具体其他使用方法与配置和 auto-changelog 原版本相同,这里不再赘述，值得注意的只有两点：

最好填写 git 远程仓库名，不然没法链接到 commit、 issue 等超链接
git 最好设置的是 GitHub 用户名，否则 @NiButCrazy 这类超链接无效
设置方法: git config --gloabl user.name "GitHub 用户名"

[!IMPORTANT] 主要是讲解一下我个人修改的内容和注意事项:

汉化了--help 命令的内容，并且为大部分命令添加了终端颜色，更加清晰有条理
将默认模板更换为了 conventional，然后又针对 conventional 模板又进行了魔改
[!WARNING] 这个模板未经过测试，可能会有小 BUG，而且目前里面的 issue 、commit hash和 auther 超链接只支持 GitHub 比如 #11 、e6cc494 或 @NiButCrazy 啥的

只针对默认模板

[!TIP] 然后就是默认模板的 git 提交消息规范和说明，点我查看详情


Feat(window): 增加了一个无边框窗口切换选项 (#521)

man: 牢大! (#520)
孩子们我坠机了

close #521  // 这是可选项，遵循 GitHub 自己的规范，链接 议题 或 issue 或 pull 用的

[!NOTE] 有顺序区别，用作 changelog 的排序依据