介绍
在前端项目中，我们经常遇到更新版本时需要更新 CHANGELOG.md 文件的情况。为了方便管理和发布版本，我们可以使用 @jvmn/groundzero-changelog 这个 npm 包来自动生成 CHANGELOG.md。
安装
在项目中安装 @jvmn/groundzero-changelog 包，可以使用以下命令：
npm install @jvmn/groundzero-changelog --save-dev
使用
配置
在项目中创建 changelog.config.js 文件并添加以下代码：
-- -------------------- ---- ------- -------------- - - --------- - - ----- -------- ------- --- ------- ------- -- ---- -- - ----- ------- ------- -- ------ ------- -- ---- -- - ----- ------ ------- --- ----- ------- -- ---- -- - ----- ------- ------- -- ------ ------- -- ---- -- - ----- ------- ------- --- ------ ------- -- ---- -- - ----- -------- ------- --- ------- ------- -- ---- -- - ----- ----------- ------- --- ---------- ------- -- ---- -- - ----- ------- ------- --- ------ ------- -- ---- -- - ----- -------- ------- --- ------- ------- -- ---- -- -- --------- ---- --- ---- -- --------- ----- ----------- --------------- --展开代码
prefixes: 定义 commit message 的前缀，包括类型、前缀、格式等。override: 是否覆盖已有的 CHANGELOG.md 文件。outputFile: 自动生成的 CHANGELOG.md 文件名称。
命令行
在 package.json 中添加以下命令：
"scripts": { "changelog": "groundzero changelog" }
在控制台运行以下命令，生成 CHANGELOG.md 文件：
npm run changelog集成
在 CI/CD 工具中集成 npm run changelog 命令，每次发布新版本时生成 CHANGELOG.md 文件。
示例
示例一
在项目中增加了文件上传功能：
git commit -m "feat: add file upload feature"
生成的 CHANGELOG.md 内容为：
# CHANGELOG ## [Unreleased] ### ✨ Feat - add file upload feature
示例二
修改了文档中的错别字：
git commit -m "docs: fix typo in README.md"
生成的 CHANGELOG.md 内容为：
# CHANGELOG ## [Unreleased] ### 📝 Docs - fix typo in README.md
结论
使用 @jvmn/groundzero-changelog 可以方便地生成 CHANGELOG.md 文件，提高项目管理和版本发布的效率。在项目中使用该包，不但可以规范commit message 的格式，还能够自动更新 CHANGELOG.md 文件。同时，也可以作为学习 CI/CD 等工具的参考。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/jvmn-groundzero-changelog
