简介
@uphold/github-changelog-generator
是一个针对 Github 仓库生成 changelog 的 npm 包。使用这个包可以方便地在你的项目中生成一份记录更新的 changelog。
安装
安装 @uphold/github-changelog-generator
可以通过 npm 完成,使用以下命令:
npm install -g @uphold/github-changelog-generator
使用方法
在项目目录下,使用以下命令生成一份 changelog 文件:
github_changelog_generator -u <username> -p <project> -t <token>
其中,username
和 project
分别为 Github 账号和项目名称,token
需要填写你的 Github personal access token,用于 Github API 的认证。注意要将 GitHub Token 替换成你自己的 token。
示例代码
github_changelog_generator -u panbirrichard -p my-project -t 123456789abcdef
以上命令会在当前目录下生成一份名为 CHANGELOG.md
的 changelog 文件。
指导意义
使用 @uphold/github-changelog-generator
记录项目更新日志,可以帮助我们更好地追踪项目的演变过程,及时发现问题并进行修复,也方便用户了解每个版本的变化情况。
当项目处于稳定状态时,我们也可以使用这个包生成一份 changelog 列表,告诉用户哪些功能不再支持,哪些 bug 已经修复等等。
总之,使用 @uphold/github-changelog-generator
可以提高我们的项目管理和维护效率,让我们的项目更加规范和有序,让用户更加舒适地使用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedc69fb5cbfe1ea061225f