卡塞尔
K级唉哟 (单位:千美元) C级绞刑ưμ㼯a欧格 折叠和自动释放更改日志的工具
使用量
所需资源
- 节点 8+
- package.json 包含一个有效的 git 仓库 URL
安装
npm i -D @brightcove/kacl
您也可以在全球安装,以便在您的项目中轻松地初始化更改日志 :
npm i -g @brightcove/kacl
CLI 使用量
如果在全球安装,您可以运行 kacl 命令。 如果没有, 您可以从您的工程的节点模块文件夹中运行 : ./node_modules/.bin/kacl
Usage: kacl init|lint|prerelease|release
init - Initializes a new CHANGELOG.md
lint - Lints your changelog for errors
prerelease - Checks the requirements for creating a new release (should be added to the "preversion" script)
release - Creates a new release matching your package.json version (should be added to the "version" script)
包装使用
kacl 在添加到 package.json 脚本时最有效,因为它可用于在运行时完全自动化更改日志 npm version。下面是设置 package.json 脚本以使用 kacl 的建议 .
{
"scripts": {
"posttest": "kacl lint",
"preversion": "kacl prerelease",
"version": "kacl release && git add CHANGELOG.md"
}
}
这种设置有:
- 运行测试后将您的更改日志剪入
- 在套取版本前检查更改日志
npm version以确保有一个未释放的条目 - 更新更改日志并在版本被撞出后添加到 git
npm version。更改日志更改将自动执行,作为npm version。 。 。 .
用法为 gh-释放
gh-释放 是自动创建标签并在 GitHub 上发布的工具。 它与卡克勒配得上很好,用两个工具,你就可以完全自动地实现版本的相撞. 以下建议设置 package.json 脚本使用 kacl 与 gh- release.
{
"scripts": {
"posttest": "kacl lint",
"preversion": "kacl prerelease",
"version": "kacl release && git add CHANGELOG.md",
"postversion": "git push && gh-release"
}
}
这与《公约》规定的步骤相同 包装使用 增加:
- 将新版本推向GitHub,并使用更新的更改日志创建了GitHub发行.
资讯
- 状况:被遗弃
- 类型: 工具
- 版本 : 语义版本
维护者
无。 离开Brightcove的前主要维护者是
- 泰德·简克兹克 @tjaneczko: 总统阁下
捐款
欢迎各方捐款,请参见 提供指南。 。 。 .
问题
这个项目使用 github 问题,请提交问题 这里。 。 。 .
捐款和感谢
该项目使用 保留更改日志 库来源 奥斯卡·奥特罗 用于解析和操纵更改日志。 这是一个很棒的图书馆,你应该检查一下是否有兴趣帮助改进项目更改日志.