默认版本控制方法

当对软件包的源代码进行更改并创建此类软件包时,一个好的做法是增加软件包的版本以表示这些更改的范围和影响。“semver”标准规范定义了一种 MAJOR.MINOR.PATCH 版本控制方法,其中每个数字的更改都具有特定含义。

Conan 基于“semver”规范实现版本控制,但具有 C 和 C++ 生态系统所要求的一些扩展功能。

  • Conan 版本可以有任意数量的数字,例如 MAJOR.MINOR.PATH.MICRO.SUBMICRO...

  • Conan 版本也可以包含字母,而不仅仅是数字,并且它们也按字母顺序排序,例如 1.a.21.b.1 更旧。

  • 版本范围同样可以定义为任意数量的数字,例如 dependency/[>=1.0.0.0 <1.0.0.10]

阅读教程中的版本控制介绍

但 C 和 C++ 构建模型与其他语言的一个非常不同的方面是,依赖项如何影响需要它们的消费者的二进制文件。这在Conan 二进制模型参考中有所描述。

基本上,当某个软件包更改其版本时,这可能会对该软件包的“消费者”产生不同的影响,要求这些“消费者”从源代码重新构建或不集成新的依赖项更改。这也取决于软件包类型,因为链接共享库或静态库时逻辑会发生变化。Conan 二进制模型结合 dependency traitspackage_typepackage_id 模式,能够表示这种逻辑并高效计算哪些需要从源代码重新构建。

默认的 Conan 行为可以给出一些提示,说明在对软件包源代码进行不同更改时,建议进行哪些版本更改。

  • 不修改版本通常意味着我们希望 Conan 自动的配方修订来处理这种情况。一个常见的用例是当 C/C++ 源代码完全没有修改,只对 conanfile.py 配方进行更改时。由于源代码相同,我们可能希望保持相同的版本号,只拥有该版本的一个新修订。

  • 补丁:增加软件包的补丁版本意味着只进行了内部更改,实际上是指对非软件包公共头文件的文件进行了更改。这种“补丁”版本可以避免重新构建此软件包的消费者,例如,如果当前获得新“补丁”版本的软件包是一个静态库,则所有依赖于此静态库并实现静态库的其他软件包都不需要从源代码重新构建,因为依赖于相同的公共接口头文件可以保证相同的二进制文件。

  • 次版本:如果对软件包的公共头文件进行了更改,并且是以 API 源代码兼容的方式,那么建议增加软件包的次版本。这意味着依赖它的其他软件包将能够无问题地编译,但由于公共头文件(可能包含 C++ 模板或可能内联到消费者软件包中的其他内容)中存在修改,因此这些消费者软件包需要从源代码重新构建以合并这些更改。

  • 主版本:如果对软件包的公共头文件进行了 API 破坏性更改,则建议增加主版本。由于最常见的推荐版本范围是类似于 dependency/[>1.0 <2],其中排除了下一个主版本,这意味着发布这些新版本不会破坏现有消费者,因为那些消费者根本不会使用它们,因为它们的版本范围会排除它们。要使用新的主版本,需要修改消费者的配方和源代码(以修复 API 破坏性更改)。

请注意,虽然这与标准“semver”对版本和版本范围的定义接近,但 C/C++ 编译模型需要引入一个新的副作用,即“需要重新构建消费者”,遵循上述 embednon_embed 情况中解释的逻辑。

这只是默认推荐的版本控制方法,但 Conan 允许更改这些默认设置,因为它实现了“semver”标准的扩展,允许任意数量的数字、字母等,并且还允许更改 package_id 模式,以定义依赖项的不同版本如何影响消费者二进制文件。请参阅如何自定义依赖项的 package_id 模式

注意

最佳实践

  • 不建议使用其他软件包引用字段,例如 userchannel 来表示源代码中的更改或其他信息,如 git 分支,因为这会变得“病毒式传播”,需要更改消费者的 requires。此外,它们在构建模型中没有实现关于哪些消费者需要重新构建的任何逻辑。

  • 推荐的方法是使用版本控制和多个服务器仓库来托管不同的软件包,这样它们就不会干扰其他构建,详情请阅读持续集成教程