在前端开发项目中自动生成 CHANGELOG.md
文件可以通过多种方式实现。以下是几种常见的方法:
方法一:使用 conventional-changelog
conventional-changelog
是一个流行的工具,可以根据 Git 提交信息自动生成 CHANGELOG.md
文件。
-
安装
conventional-changelog-cli
和conventional-changelog-gitmoji-config
npm install --save-dev conventional-changelog-cli conventional-changelog-gitmoji-config
-
创建
changelog.config.js
配置文件module.exports = { config: 'conventional-changelog-gitmoji-config' };
-
在
package.json
中添加脚本{ "scripts": { "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s" } }
-
运行脚本生成
CHANGELOG.md
npm run changelog
方法二:使用 standard-version
standard-version
是一个更高级的工具,可以自动更新版本号并生成 CHANGELOG.md
文件。
-
安装
standard-version
npm install --save-dev standard-version
-
在
package.json
中添加脚本{ "scripts": { "release": "standard-version" } }
-
运行脚本生成
CHANGELOG.md
并更新版本号npm run release
方法三:使用 git-changelog
git-changelog
是一个基于 Git 日志生成 CHANGELOG.md
的工具。
-
安装
git-changelog-cli
npm install --save-dev git-changelog-cli
-
在
package.json
中添加脚本{ "scripts": { "changelog": "git-changelog -o CHANGELOG.md" } }
-
运行脚本生成
CHANGELOG.md
npm run changelog
方法四:使用 github-changelog-generator
github-changelog-generator
是一个基于 GitHub 仓库生成 CHANGELOG.md
的工具。
-
安装
github-changelog-generator
npm install --save-dev github-changelog-generator
-
在
package.json
中添加脚本{ "scripts": { "changelog": "github-changelog-generator -u <username> -p <repo>" } }
替换
<username>
和<repo>
为你的 GitHub 用户名和仓库名。 -
运行脚本生成
CHANGELOG.md
npm run changelog
总结
以上方法各有优缺点,可以根据自己的需求选择合适的方法。通常情况下,conventional-changelog
和 standard-version
是比较常用的选择,因为它们可以很好地与 Git 提交信息集成,并且可以自动生成版本号。