GitVersion项目中AssemblyInformationalVersion属性被追加SHA问题的分析与解决

问题背景

在使用GitVersion.MSBuild 6.0.0版本时，开发者发现一个特殊现象：当在GenerateGitVersionInformation任务之后、CoreGenerateAssemblyInfo任务之前修改gitversion.json文件时，生成的AssemblyInformationalVersion属性会包含完整的Git SHA值，而不是预期的版本信息。

现象描述

开发者观察到以下具体现象：

1. 修改后的gitversion.json文件中包含正确的InformationalVersion字段，例如"1.2.3+Informational"
2. 生成的GitVersionInformation.g.cs文件中也正确包含了这个版本信息
3. 但最终编译后的DLL中，AssemblyInformationalVersion属性却变成了"1.2.3+Informational.f9c0808df67d3e6b21c0c4c27051b3befe469f69"的形式，即自动追加了完整的Git提交哈希

技术分析

这个问题实际上与.NET SDK 8.0的一个新特性有关。在.NET 8中，SDK默认会在AssemblyInformationalVersion属性中自动包含源代码的Git提交哈希。这个设计是为了提供更精确的版本追踪能力，特别是在持续集成和部署环境中。

GitVersion本身生成的版本信息是正确的，但.NET SDK在后续的构建过程中会再次处理这个版本信息，追加Git提交哈希。这种行为是SDK的默认设置，而不是GitVersion的问题。

解决方案

要解决这个问题，可以在项目文件中添加以下属性设置：

<PropertyGroup>
  <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
</PropertyGroup>

这个设置会告诉.NET SDK不要在AssemblyInformationalVersion中包含源代码版本信息，从而保留GitVersion生成的原始版本信息。

深入理解

这个问题的出现实际上是两个版本控制系统（GitVersion和.NET SDK）在构建过程中的交互结果。理解这一点对于现代.NET开发很重要：

1. GitVersion负责基于Git仓库状态生成语义化版本
2. .NET SDK负责最终的AssemblyInfo生成和编译过程
3. 从.NET 8开始，SDK默认会增强版本信息以包含更多构建上下文

对于需要精确控制版本信息格式的项目，明确设置IncludeSourceRevisionInInformationalVersion属性是一个好的实践。

最佳实践建议

1. 如果项目需要严格的版本控制，建议显式设置IncludeSourceRevisionInInformationalVersion
2. 对于库项目，保持简洁的版本号可能更有利于使用者
3. 对于应用程序，包含更多构建上下文信息可能有助于问题诊断
4. 在持续集成环境中，可以考虑根据构建类型动态设置这个属性

通过理解这些机制，开发者可以更好地控制项目的版本信息生成过程，确保符合项目的具体需求。