在前端开发中，版本控制是非常重要的一环。而遵循**约定式提交规范（Conventional Commits Specification）**则可以为我们的版本管理带来很大的便利性。conventional-changelog-atom就是一个使用约定式提交规范生成 changelog 的工具。
安装
在终端中执行以下命令安装 conventional-changelog-atom：
npm install -g conventional-changelog-atom
使用方法
1. 配置
在项目目录下创建 .versionrc.json 文件，并填写以下内容：
-- -------------------- ---- -------
-
--------- -- -----------
-------- -
- ------- ------- ---------- ---------- --
- ------- ------ ---------- ---- ------ --
- ------- ------- ---------- --------------- --
- ------- -------- ---------- --------- --------- ---- --
- ------- ----------- ---------- ----- ------------ --
- ------- ------- ---------- ------------ ------------- --
- ------- ------- ---------- -------- --------- ---- --
- ------- -------- ---------- ------ -------- --------- ---- --
- ------- ----- ---------- ----------- ------------- --------- ---- --
- ------- -------- ---------- --------- --------- ---- --
- ------- --------- ---------- ---------- --------- ---- -
-
-注意，conventional-changelog-atom使用的是 semantic-release 插件，所以你需要在项目中安装它。
2. 运行
在终端中进入项目目录，并执行以下命令：
conventional-changelog -p atom -i CHANGELOG.md -s -r 0
参数说明：
-p atom：指定使用atom的风格生成 changelog。-i CHANGELOG.md：指定输出文件路径和名称。-s：表示生成的内容放在最前面，而不是追加到文件末尾。-r 0：表示从头开始生成 changelog。
3. 定期运行
为了保证 changelog 的时效性，我们可以将上述命令添加到 CI/CD 工作流中，每次发布时都会自动生成并更新 changelog。
示例代码
以下是一个示例提交信息：
feat: add login function
根据配置文件，此提交将被归类为"Features"，生成的 changelog 如下：
# Changelog ## Features * add login function
这样的 changelog 不仅易于阅读，而且可以方便地进行版本对比、查看新增功能等操作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/49575