Conventional Commits 和 standard-version 是两个与 Git 提交消息和版本管理相关的工具，但它们的功能和用途有所不同。以下是它们的区别和联系：

1. Conventional Commits ​

1.1 定义 ​

Conventional Commits 是一种 提交消息规范，它定义了一种标准化的 Git 提交消息格式，便于自动化工具解析提交历史并生成变更日志。

1.2 提交消息格式 ​

<类型>(<范围>): <描述>

[可选正文]

[可选脚注]

<类型>(<范围>): <描述>

[可选正文]

[可选脚注]

• 类型：如 feat（新功能）、fix（修复 bug）、docs（文档更新）等。
• 范围：可选，表示影响的范围（如模块或文件）。
• 描述：简洁明了地描述提交内容。
• 正文：可选，提供更详细的说明。
• 脚注：可选，用于关联 Issue 或标记破坏性变更。

示例：

feat(user): 添加用户登录功能

Closes #123

feat(user): 添加用户登录功能

Closes #123

1.3 作用 ​

• 提高提交消息的可读性和一致性。
• 便于自动化工具解析提交历史，生成变更日志或版本号。

2. standard-version ​

2.1 定义 ​

standard-version 是一个 自动化版本管理工具，它基于 Conventional Commits 规范，自动完成以下任务：

1. 根据提交历史生成变更日志（CHANGELOG.md）。
2. 根据提交类型（如 feat 或 fix）自动递增版本号。
3. 创建 Git 标签（Tag）并提交变更。

2.2 功能 ​

• 版本号管理：
  • feat 提交：递增次版本号（Minor）。
  • fix 提交：递增修订号（Patch）。
  • 包含 BREAKING CHANGE 的提交：递增主版本号（Major）。
• 变更日志生成：
  • 根据提交消息自动生成 CHANGELOG.md。
• Git 标签：
  • 自动创建版本标签（如 v1.2.3）。

2.3 使用示例 ​

1. 安装 standard-version：

   bash

   npm install --save-dev standard-version

   npm install --save-dev standard-version

   1
   

2. 在 package.json 中添加脚本：

   json

   "scripts": {
     "release": "standard-version"
   }

   "scripts": {
     "release": "standard-version"
   }

   1
   2
   3
   

3. 运行发布命令：

   bash

   npm run release

   npm run release

   1
   

3. 区别与联系 ​

3.1 区别 ​

3.2 联系 ​

• standard-version 是基于 Conventional Commits 规范的工具。
• Conventional Commits 提供了提交消息的标准化格式，standard-version 利用这些格式来自动化版本管理。

4. 结合使用 ​

4.1 工作流程 ​

1. 开发阶段：

   • 开发者遵循 Conventional Commits 规范提交代码。
   • 示例提交：
     bash

     git commit -m "feat(user): 添加用户登录功能"
     git commit -m "fix(auth): 修复登录失败的问题"

     git commit -m "feat(user): 添加用户登录功能"
     git commit -m "fix(auth): 修复登录失败的问题"

     1
     2
     

2. 发布阶段：

   • 运行 standard-version 自动生成变更日志、递增版本号并创建标签。
   • 示例命令：
     bash

     npm run release

     npm run release

     1
     

3. 结果：

   • 生成 CHANGELOG.md 文件。
   • 更新 package.json 中的版本号。
   • 创建 Git 标签（如 v1.2.3）。

4.2 配置文件 ​

可以在 package.json 中配置 standard-version 的行为，例如：

"standard-version": {
  "skip": {
    "tag": false
  },
  "releaseCommitMessageFormat": "chore(release): {{currentTag}}"
}

"standard-version": {
  "skip": {
    "tag": false
  },
  "releaseCommitMessageFormat": "chore(release): {{currentTag}}"
}

5. 总结 ​

• Conventional Commits 是一种提交消息规范，用于统一提交格式。
• standard-version 是一个自动化工具，基于 Conventional Commits 规范，用于版本管理和变更日志生成。
• 两者结合使用，可以实现从代码提交到版本发布的全流程自动化。

要在 Spring Boot 项目中使用 standard-version 来生成本地的 CHANGELOG.md 文件，需要以下步骤。standard-version 是一个自动化工具，用于根据 Git 提交消息生成变更日志，并根据语义版本控制（semver）规则自动版本发布。

1. 安装 Node.js 和 npm ​

standard-version 是一个 Node.js 工具，因此首先需要安装 Node.js 和 npm（Node 的包管理器）。你可以通过以下命令检查是否已经安装：

node -v
npm -v

node -v
npm -v

如果尚未安装，请前往官网下载安装。

2. 初始化项目并安装 standard-version ​

在 Spring Boot 项目中，虽然我们主要使用 Java，但为了自动化管理版本和生成 CHANGELOG.md 文件，我们需要在项目中集成 standard-version。

1. 进入项目根目录： 进入到你的 Spring Boot 项目的根目录。

2. 初始化 npm 项目： 如果项目还没有 package.json 文件，可以运行以下命令来初始化：

npm init -y

npm init -y

3. 安装 standard-version： 在项目中安装 standard-version，将其作为开发依赖：

npm install --save-dev standard-version

npm install --save-dev standard-version

3. 配置 standard-version ​

standard-version 会根据你的 Git 提交记录生成版本号和 CHANGELOG.md 文件。你可以在 package.json 中添加一些脚本来方便运行。

1. 打开 package.json 文件。
2. 在 scripts 部分添加一个 release 脚本：

"scripts": {
"release": "standard-version"
}

"scripts": {
"release": "standard-version"
}

这将使你能够使用 npm run release 命令来运行 standard-version。

4. 使用 Git 提交消息格式化 ​

standard-version 会根据语义化版本控制（Semantic Versioning）和 Git 提交消息的格式来生成 CHANGELOG.md。你需要遵循一定的提交消息格式。

以下是标准的提交消息格式：

• feat: 用于增加新特性
• fix: 用于修复 bug
• docs: 用于文档更改
• chore: 用于不影响代码的变动（例如依赖更新、工具配置等）
• style: 用于代码风格修复（空格、缩进、逗号等格式）
• refactor: 用于重构代码（没有新增功能或修复 bug）
• test: 用于添加缺失的测试或修复已有测试

例如：

git commit -m "feat: add login functionality"
git commit -m "fix: resolve null pointer exception"
git commit -m "chore: update dependencies"

git commit -m "feat: add login functionality"
git commit -m "fix: resolve null pointer exception"
git commit -m "chore: update dependencies"

重大变更，提交格式

feat(基础模块重构): 重构数据存储模块
BREAKING CHANGE: 数据存储接口改变，需要用户重新配置连接设置。

feat(基础模块重构): 重构数据存储模块
BREAKING CHANGE: 数据存储接口改变，需要用户重新配置连接设置。

5. 运行 standard-version 生成 CHANGELOG.md ​

在每次版本发布时，执行以下命令：

npm run release

npm run release

该命令会根据 Git 提交记录自动生成一个新的版本号，并更新 CHANGELOG.md 文件。生成的版本号遵循语义版本控制规则（如：v1.0.1、v2.0.0）。同时，CHANGELOG.md 文件会被更新，格式如下：

# Changelog

## [1.1.0] - 2025-03-04
### Added
- feat: add login functionality

### Fixed
- fix: resolve null pointer exception

## [1.0.0] - 2025-02-20
### Added
- Initial release

# Changelog

## [1.1.0] - 2025-03-04
### Added
- feat: add login functionality

### Fixed
- fix: resolve null pointer exception

## [1.0.0] - 2025-02-20
### Added
- Initial release

6. 推送更改并发布 ​

在生成了新的版本和 CHANGELOG.md 文件之后，你可以推送更改到远程 Git 仓库：

git push --follow-tags

git push --follow-tags

standard-version 会自动为你创建一个 Git 标签（tag），标记版本。

7. 测试过程的数据清理 ​

PS D:\gitlab\ruoyi-vue> git tag
1.1.0
1.1.1
v1.2.3
v1.2.4
PS D:\gitlab\ruoyi-vue> git tag -d v1.2.3 v1.2.4
Deleted tag 'v1.2.3' (was 58244956)
Deleted tag 'v1.2.4' (was e23cd159)

PS D:\gitlab\ruoyi-vue> git tag
1.1.0
1.1.1
v1.2.3
v1.2.4
PS D:\gitlab\ruoyi-vue> git tag -d v1.2.3 v1.2.4
Deleted tag 'v1.2.3' (was 58244956)
Deleted tag 'v1.2.4' (was e23cd159)

8. 合并一个临时分支为一次提交 ​

//创建临时分支，多次提交内容
git checkout -b temp-branch
//切换目标分支
git checkout <target-branch>
//合并临时分支，合并成一次提交
git merge --squash <temp-branch>
//删除临时分支
git branch -d temp-branch
//推送分支
git push --force

//创建临时分支，多次提交内容
git checkout -b temp-branch
//切换目标分支
git checkout <target-branch>
//合并临时分支，合并成一次提交
git merge --squash <temp-branch>
//删除临时分支
git branch -d temp-branch
//推送分支
git push --force

总结 ​

• 通过 npm init -y 创建一个 package.json 文件。
• 安装 standard-version：npm install --save-dev standard-version。
• 在 package.json 中添加 release 脚本。
• 提交消息遵循语义化版本控制规范。
• 使用 npm run release 来自动生成版本号和更新 CHANGELOG.md。