优化代码变更: 从 Commit 规范化到发布自定义 CHANGELOG 模板

2023-10-22 04:03:53

在现代软件开发中，代码变更管理和版本发布是两个不可或缺的重要环节。清晰的代码变更规范和定制化的 CHANGELOG 模板可以显著提升团队协作效率和项目透明度。本文将带领您从提交规范化到发布自定义 CHANGELOG 模板，逐一攻克优化代码变更管理和版本发布流程的难关。

1. 规范化 Commit 消息

清晰的 Commit 消息是高效代码变更管理的基础。一套完善的 Commit 规范可以确保提交信息易于理解、语义明确，从而为后续的代码审查、版本发布和故障追溯奠定坚实的基础。

**使用动词作为提交
简短而明确： 保持提交标题简洁，便于快速浏览。
使用祈使语气： 使用祈使语气提交内容，例如 "修复bug"，避免使用完成时态，如 "修复了bug"。
避免使用人称代词： 避免使用 "我"、"你" 等人称代词，让提交消息更具客观性。
提供相关引用： 若提交与某一 issue 或 pull request 相关，请在提交消息中添加引用，便于追踪关联信息。

2. 使用 lint-staged 强制提交规范

lint-staged 是一个强大的工具，它允许您在提交代码之前检查代码是否符合您的规范。您可以使用 lint-staged 来检查提交消息是否符合规范，以及代码是否通过了单元测试。

要使用 lint-staged，您需要在项目中安装它。您可以使用以下命令安装 lint-staged：

npm install --save-dev lint-staged

安装 lint-staged 后，您需要创建一个 .lintstagedrc 文件。在 .lintstagedrc 文件中，您可以指定要在提交代码之前运行的检查。

以下是一个 .lintstagedrc 文件的示例：

module.exports = {
  '*.js': [
    'eslint --fix',
    'git add'
  ],
  '*.json': [
    'jsonlint --fix',
    'git add'
  ]
};

在这个示例中，我们指定了在提交 JavaScript 和 JSON 文件之前，需要先运行 eslint 和 jsonlint 来检查代码是否符合规范。

3. 使用 conventional-changelog-cli 自动生成 CHANGELOG

conventional-changelog-cli 是一个命令行工具，它可以帮助您根据 Git 提交记录自动生成 CHANGELOG。conventional-changelog-cli 支持多种 CHANGELOG 格式，包括 Markdown、HTML 和 JSON。

要使用 conventional-changelog-cli，您需要在项目中安装它。您可以使用以下命令安装 conventional-changelog-cli：

npm install --save-dev conventional-changelog-cli

安装 conventional-changelog-cli 后，您需要创建一个 .conventionalchangelogrc 文件。在 .conventionalchangelogrc 文件中，您可以指定 CHANGELOG 的格式和生成规则。

以下是一个 .conventionalchangelogrc 文件的示例：

{
  "preset": "angular",
  "releaseCount": 10,
  "infile": "CHANGELOG.md"
}

在这个示例中，我们指定了使用 Angular 的 CHANGELOG 预设，并指定了要生成最近 10 个版本的 CHANGELOG。

4. 自动化版本发布流程

现在，您可以使用 lint-staged 和 conventional-changelog-cli 来自动化版本发布流程。您可以使用以下命令来发布新版本：

npm run release

此命令将运行 lint-staged 来检查代码是否符合规范，然后运行 conventional-changelog-cli 来生成新的 CHANGELOG，最后将新版本发布到 NPM。

结论

通过优化 Commit 规范化、使用 lint-staged 强制提交规范、使用 conventional-changelog-cli 自动生成 CHANGELOG，以及自动化版本发布流程，您可以显著提升代码变更管理和项目发布的效率与质量。这套组合拳不仅可以帮助您轻松维护项目的代码库，还能让您快速发布高质量的新版本，为您的团队和项目带来更多价值。