GitVersion 项目使用教程

GitVersion 项目使用教程

1. 项目的目录结构及介绍

GitVersion 是一个用于生成语义化版本号的工具，其项目目录结构如下：

git-version/
├── src/
│   ├── GitVersion.Core/
│   ├── GitVersion.CommandLine/
│   ├── GitVersion.MsBuild/
│   └── GitVersion.Tool/
├── tests/
│   ├── GitVersion.Core.Tests/
│   ├── GitVersion.IntegrationTests/
│   └── GitVersion.MsBuild.Tests/
├── docs/
├── .gitignore
├── .gitattributes
├── GitVersion.sln
├── LICENSE
└── README.md

目录介绍

• src/: 包含 GitVersion 的核心代码和不同平台的实现。
  • GitVersion.Core/: 核心库，包含版本号生成的逻辑。
  • GitVersion.CommandLine/: 命令行工具。
  • GitVersion.MsBuild/: MSBuild 任务。
  • GitVersion.Tool/: .NET 工具。
• tests/: 包含项目的单元测试和集成测试。
  • GitVersion.Core.Tests/: 核心库的单元测试。
  • GitVersion.IntegrationTests/: 集成测试。
  • GitVersion.MsBuild.Tests/: MSBuild 任务的测试。
• docs/: 项目文档。
• .gitignore: Git 忽略文件配置。
• .gitattributes: Git 属性配置。
• GitVersion.sln: Visual Studio 解决方案文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

GitVersion 的启动文件主要是命令行工具和 MSBuild 任务。

命令行工具

命令行工具位于 src/GitVersion.CommandLine/ 目录下，主要的启动文件是 GitVersion.exe。

MSBuild 任务

MSBuild 任务位于 src/GitVersion.MsBuild/ 目录下，主要的启动文件是 GitVersion.MsBuild.Tasks.dll。

3. 项目的配置文件介绍

GitVersion 的配置文件是 GitVersion.yml 或 GitVersion.json，用于配置版本号生成的规则。

配置文件示例

mode: ContinuousDelivery
branches:
  master:
    increment: Minor
  feature:
    increment: Minor
  release:
    increment: Patch
  hotfix:
    increment: Patch
  support:
    increment: Minor

配置项说明

• mode: 版本号生成模式，支持 ContinuousDelivery 和 ContinuousDeployment。
• branches: 分支配置，定义不同分支的版本号递增规则。
  • increment: 版本号递增规则，支持 Major、Minor 和 Patch。

通过以上配置，GitVersion 可以根据项目的 Git 历史自动生成语义化版本号。