默认版本控制方法

当对包的源代码进行更改并创建这样的包时,一个好的实践是增加包的版本,以表示这些更改的范围和影响。“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 二进制模型 参考中描述。

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

默认的 Conan 行为可以提供一些关于在对包源代码进行不同更改时建议进行的版本更改的提示

  • 不修改版本通常意味着我们希望 Conan 自动处理recipe revisions。 一种常见的用例是根本不修改 C/C++ 源代码,而只修改 conanfile.py recipe。由于源代码是相同的,我们可能希望保留相同的版本号,而只拥有该版本的新修订版本。

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

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

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

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

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

注意

最佳实践

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

  • 推荐的方法是使用版本控制和多个服务器存储库来托管不同的包,这样它们就不会干扰其他构建,请阅读 持续集成教程 以了解更多详细信息。