auto-changelog 是一个自动生成项目的 changelog(变更日志)的 npm 包。它可以根据 git 的提交历史和标签信息,生成一个清晰明了的 changelog 并且可以自定义输出格式。在协作开发中,changelog 非常重要。本文将介绍如何安装和使用 auto-changelog。
安装
在安装之前,请确保您已经安装了 npm 和 Node.js。
npm install -g auto-changelog
使用方法
基础用法
通过以下命令可以在当前目录下生成 CHANGELOG.md 文件:
auto-changelog
参数选项
auto-changelog 提供了许多参数来帮助您定制化您的 changelog。下面是一些常用的选项:
--output
或-o
: 指定输出文件路径和文件名,默认为当前目录下的 CHANGELOG.md。--commit-limit
或-c
: 设置最大提交数。--unreleased
或-u
: 显示未发布的更改。--tag-prefix
: 指定 tag 的前缀。--template
: 指定渲染 changelog 的模板,默认为 default 模板。
例如,以下命令将在当前目录下生成一个包含未发布更改的 changelog 文件 my-changelog.md
,并且只显示最近 10 次的提交记录:
auto-changelog --unreleased -o my-changelog.md --commit-limit 10
自定义模板
除了默认模板之外,auto-changelog 还支持自定义模板。您可以在 templates 目录下找到一些可用的模板。您也可以创建自己的模板文件,例如 my-template.hbs
,然后通过以下命令指定模板:
auto-changelog --template my-template.hbs
使用自定义模板需要一定的 Handlebars 知识。
示例代码
以下是一个简单示例的代码:
-- -------------------- ---- ------- --- ---- -- --- ------- -- -------------- --- ---- ---- -- -------------- -------- - --------- --- --- - --- ------ -- -------- ------- --- --- ------ ---- ----- -------- -- --------- --- --- - --- ------ -- ---- ---- -------- --- --- ------ --------------
运行以上代码后,您将会在当前目录下生成一个名为 CHANGELOG.md 的 changelog 文件。
总结
auto-changelog 是一个非常有用的工具,它可以帮助我们自动生成项目的 changelog,减少编写 changelog 的时间和手动操作的繁琐性。希望这篇文章对您有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/42313