默认版本控制方法

当对包的源代码进行更改并创建这样的包时,一个好的做法是增加包的版本以反映这些更改的范围和影响。“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 配方进行了更改时。由于源代码相同,我们可能希望保持相同的版本号,并只为该版本生成新的修订。

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

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

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

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

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

注意

最佳实践

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

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