简介
llama-rlsr-keep-a-changelog
是一个 npm 包,提供了一个命令行工具,可以帮助前端开发者自动生成 CHANGELOG 文件,使版本控制更加规范。
安装
在终端中输入以下命令,即可安装 llama-rlsr-keep-a-changelog
:
--- ------- -- ---------------------------
使用方法
生成 CHANGELOG
在终端中,进入项目根目录,运行以下命令即可生成 CHANGELOG:
----
这将根据 git 提交记录自动生成 CHANGELOG,提交记录中需要按 Angular 规范格式书写。
指定 git 仓库
如果项目的 git 仓库名称不是默认的 origin
,则可以在命令中指定 git 仓库:
---- -------------
指定 tag 格式
如果项目 tag 的格式不同于默认的 v${VERSION}
,则可以在命令中指定 tag 格式:
---- --------------------------
指定从某个 tag 开始生成 CHANGELOG
如果想从某个已发布的 tag 开始生成 CHANGELOG,则可以在命令中指定起始 tag:
---- ------------------
指定版本
如果想只生成某个版本的 CHANGELOG,则可以在命令中指定版本:
---- ---------------
自定义模板
如果想使用自定义的模板来生成 CHANGELOG,则可以在命令中指定模板文件:
---- ---------------------------
模板文件需要包含以下变量:
title
:版本标题date
:版本发布时间description
:版本描述commits
:提交记录列表
其中 commits
是一个数组,包含以下变量:
type
:提交类型description
:提交描述author
:作者pullRequest
:关联的 Pull Request
示例模板:
- --------- -- -- ----- -- --- ---- --- --------------------------------------------------- ------------ - -------- --------------- ------------ ------------
实例
假设我们有一个名为 test-project
的项目,使用 llama-rlsr-keep-a-changelog
生成 CHANGELOG 的过程如下:
安装:
--- ------- -- ---------------------------
进入项目根目录:
-- ------------
生成 CHANGELOG:
----
如果想使用自定义模板,则可以将模板文件 my-template.md
放入项目根目录,并在命令中指定:
---- ---------------------------
总结
使用 llama-rlsr-keep-a-changelog
可以帮助开发者更好地管理版本,遵守规范,提高代码可维护性。通过指定不同的参数,可以生成满足需求的 CHANGELOG。 希望本文对读者有所帮助!
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60055fc781e8991b448dd40d