vscode没有直接生成更新日志的快捷键,但可通过以下方法高效实现:1. 利用git命令如git log –pretty=format:”- %s (%h)” > changelog.md生成基础日志;2. 安装“conventional commits”等插件规范提交信息,配合“auto-changelog”工具自动生成结构化日志;3. 创建自定义snippets预设模板,通过快捷键快速插入常用内容;4. 使用vscode task运行自定义脚本,结合git tag标记版本范围避免日志混淆;5. 将生成脚本集成到ci/cd流程(如github actions),在发布时自动更新github releases、package.json或readme.md,确保日志准确及时。该方案完整覆盖从提交规范到自动化发布的全流程,显著提升效率并减少人为错误。
VSCode本身并没有直接生成版本更新日志的快捷键,但我们可以通过插件和一些小技巧来高效地完成这项工作。
解决方案
-
利用Git和命令行: 这是最基础也是最强大的方法。VSCode集成了Git,你可以使用命令行来提取提交历史,然后格式化成更新日志。比如,
git log --pretty=format:"- %s (%h)" > CHANGELOG.md
可以生成一个简单的 Markdown 格式的更新日志。
-
安装相关插件: VSCode 市场里有很多插件可以辅助生成更新日志,例如 “Conventional Commits” 插件,它可以帮助你规范提交信息,然后你可以使用 “auto-changelog” 工具根据这些规范的提交信息自动生成更新日志。
-
自定义 Snippets: 如果你经常需要手动编写更新日志,可以创建 VSCode 的 Snippets,预定义一些常用的更新日志模板,然后通过快捷键快速插入。
如何规范你的提交信息以方便生成更新日志?
规范的提交信息是自动生成更新日志的基础。推荐使用 “Conventional Commits” 规范。简单来说,就是你的提交信息应该包含类型(如
feat
、
fix
、
docs
、
style
、
refactor
、
perf
、
test
),作用域(可选),以及描述。例如:
feat(auth): implement user login
。 这样,”auto-changelog” 之类的工具才能正确识别你的提交,并生成结构化的更新日志。 我个人觉得 scope 这一块挺灵活的,可以根据项目需要进行调整,比如按模块划分。
除了插件,还有哪些提高效率的小技巧?
除了插件,一些小技巧也能帮你提高效率。 比如,你可以创建一个专门用于生成更新日志的脚本,然后通过 VSCode 的 Task 功能来运行它。 这样,你只需要在 VSCode 里按一个快捷键,就可以自动生成更新日志了。 另外,善用 Git 的 tag 功能,可以方便地标记版本,并在生成更新日志时指定版本范围。 我之前就遇到过一个问题,忘记打 tag 了,结果生成出来的更新日志包含了不属于当前版本的提交,还得手动筛选,挺麻烦的。
如何将生成的更新日志集成到你的 CI/CD 流程中?
将更新日志集成到 CI/CD 流程中,可以实现自动化发布。 例如,你可以使用 GitHub Actions,在每次发布新版本时,自动生成更新日志,并将其添加到 GitHub Releases 中。 这需要你在 CI/CD 流程中运行生成更新日志的脚本,并将生成的更新日志上传到 GitHub Releases。 我见过一些项目,在发布时会同时更新 npm 包的
package.json
文件,并将更新日志添加到
README.md
文件中,这样可以方便用户查看最新的更新信息。 这种自动化流程可以节省大量的时间和精力,并确保更新日志的准确性和及时性。
评论(已关闭)
评论已关闭