自动变更日志+规范git记录(release-it+husky+ commitizen+ commitli...
发布网友
发布时间：1天前
共1个回答
热心网友
时间：6分钟前
引言
每次编写Git提交记录后，还需在多个地方同步项目进展，这无疑增加了操作的繁琐性。为了简化这一流程，应将每次提交信息整理至变更日志文档，以便在需要时复制粘贴使用。在探讨如何自动化生成变更日志前，首先需要解决如何生成符合规范的Git提交信息，以避免无序且难以维护的提交历史。本文将介绍Conventional Commits规范，并通过工具如release-it、husky、commitizen和commitlint，实现自动化和规范化提交记录。
规范生成提交信息
Conventional Commits规范为日常提交提供了一套清晰的标准格式，包括类型、主体和附注。遵循这些规则，可确保提交信息结构化、可读性强，便于后续整理和查询。虽然本文不会详细解释规范内容，但使用commitizen等工具可轻松生成符合Conventional Commits标准的提交信息。
初始化项目与安装工具
快速创建项目并初始化，为后续演示做好准备。通过安装commitizen，将自动完成提交信息的生成。commitizen会提问有关变更类型、范围、描述、重大变更和关联issue等问题，生成符合规范的提交信息。
配置和使用commitizen
输入命令安装commitizen适配器，探索更多可用选项。在package.json中添加相应脚本，以便在执行提交操作时调用commitizen。创建.gitignore文件，将node_modules排除，以保持项目整洁。
使用husky和commitlint确保规范性
对于未使用commitizen生成提交信息的团队成员，可借助husky和commitlint确保遵循Conventional Commits规范。husky作为Git钩子，拦截不符合规范的提交，commitlint则在提交前检查提交信息格式。通过在package.json中配置husky install，确保每个参与者在开始使用项目前完成规范检查。
生成变更日志
通过release-it自动创建和更新CHANGELOG.md文件，记录项目版本间的变更。首先在GitHub上创建一个changelog仓库，然后将本地内容推送到远程仓库。安装release-it并配置忽略npm发布。若希望显示除feat和fix之外的其他提交类型，需要调整release-it配置，同时自定义生成tag时的提交信息。
定制变更日志
根据Conventional Commits规范，使用release-it自定义展示类型标题，如将docs类型标题更改为"文档"。通过修改.release-it.json文件中的相关配置，可进一步定制变更日志的展示方式。借助gitmoji.dev这类资源，可为各种提交类型添加emoji表情，增强日志的可读性。
总结与展望
通过commitizen、husky、commitlint和release-it，项目团队可实现从提交信息生成到变更日志自动化和规范化的全流程管理。遵循Conventional Commits规范不仅简化了项目维护流程，还提供了清晰、一致的日志记录，便于团队成员追踪项目进展和版本变更。未来，可继续探索更多工具和技术，进一步优化变更管理流程，提高团队协作效率。
