什么是@release-it/conventional-changelog
@release-it/conventional-changelog是一个npm包,它是Conventional Changelog的一个实现,专门用于自动化生成支持semantic版本控制的changelog,帮助项目维护者更轻松高效地管理版本更新的记录。
如何使用@release-it/conventional-changelog
安装@release-it/conventional-changelog:
npm install -D @release-it/conventional-changelog
在release-it的配置文件中,可以使用@release-it/conventional-changelog:
{ "plugins": { "@release-it/conventional-changelog": { "preset": "angular" } } }
其中“preset”属性表示使用哪个约定,@release-it/conventional-changelog内置了几个畅行约定,可以通过这个属性来指定使用哪个约定。
“angular”约定是最常用的一个,它遵循了Airbnb JavaScript Style Guide的规范。
运行release-it时,@release-it/conventional-changelog插件将检测commit信息中的重要内容,并自动生成对应格式的changelog:
npx release-it --no-increment --no-git.tag
此时,会自动在package.json中发布版本,生成对应的changelog,而版本号不会自动更新是因为--no-increment选项。如果需要自动升级版本,可以去掉这个选项。
@release-it/conventional-changelog的好处
使用@release-it/conventional-changelog提供的自动化解决方案,项目维护者不再需要手动撰写版本升级记录,极大地减轻了项目管理工作量。
同时,它也遵循了semantic版本控制的标准语义,方便项目使用者快速地找到自己所需要的版本更新信息。
示例代码
{ "plugins": { "@release-it/conventional-changelog": { "preset": "angular" } } }
结束语
@release-it/conventional-changelog是一个十分好用的npm包,能够大大减轻项目维护者的工作量。希望本文对于您学习和使用该npm包时有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/168462