GitVersion.MsBuild 实现静态版本信息注入而不修改程序集版本的技术实践

背景介绍

在.NET开发中，版本控制是一个重要环节。GitVersion作为一款流行的版本控制工具，能够根据Git仓库的提交历史自动生成语义化版本号。然而在某些特殊场景下，开发者希望保留手动指定的程序集版本，同时又能获取GitVersion生成的版本信息用于其他用途。

问题场景

在微软Dynamics 365 CRM插件开发中，版本控制有其特殊性。当多个开发者在共享的CRM开发实例上工作时，如果使用完全自动化的版本控制，可能会出现版本降级问题。这是因为不同开发者可能基于不同代码版本进行开发，自动生成的版本号可能与CRM中已注册的插件版本不兼容。

技术挑战

GitVersion.MsBuild默认会修改程序集的以下版本属性：

• AssemblyVersion
• AssemblyFileVersion
• AssemblyInformationalVersion

这会导致即使开发者在.csproj文件中明确指定了版本号，最终生成的程序集版本仍可能被GitVersion覆盖，造成CRM插件注册失败。

解决方案

通过深入研究GitVersion.MsBuild的任务配置，我们发现可以通过以下组合配置实现：

1. 保留手动指定的程序集版本
2. 同时生成GitVersionInformation静态类

关键配置如下：

<UpdateAssemblyInfo>false</UpdateAssemblyInfo>
<UpdateVersionProperties>false</UpdateVersionProperties>
<GenerateAssemblyFileVersionAttribute>true</GenerateAssemblyFileVersionAttribute>
<GenerateAssemblyInformationalVersionAttribute>true</GenerateAssemblyInformationalVersionAttribute>
<GenerateAssemblyVersionAttribute>true</GenerateAssemblyVersionAttribute>

配置解析

1. UpdateAssemblyInfo：设为false防止修改AssemblyInfo文件
2. UpdateVersionProperties：设为false阻止更新MSBuild版本属性
3. GenerateXXXAttribute：显式设为true确保生成对应的版本特性

实现原理

这种配置组合的工作原理是：

• 禁用所有可能修改实际程序集版本的行为
• 显式启用版本特性的生成，确保GitVersionInformation类被正确创建
• 保留.csproj中手动指定的版本信息

注意事项

1. 在CRM插件开发中，建议始终使用强名称签名
2. 版本号变更应谨慎处理，避免CRM中的版本冲突
3. 团队开发时应协调版本控制策略

最佳实践

对于类似的特殊场景，我们建议：

1. 先在测试环境中验证版本控制方案
2. 文档化团队的版本控制策略
3. 考虑使用持续集成管道统一管理版本号
4. 对于CRM插件，可以建立版本号与解决方案版本号的映射关系

总结

通过合理配置GitVersion.MsBuild，开发者可以在保留手动版本控制的同时，享受GitVersion提供的版本信息追踪能力。这种方案特别适合需要严格控制程序集版本的特殊场景，如CRM插件开发、COM组件等。理解各配置项的相互作用是实现这一平衡的关键。