版本控制简介

到目前为止,我们一直在使用固定版本的 requires,例如 requires = "zlib/1.2.12"。但有时依赖项会演变,会发布新版本,而使用者希望尽可能轻松地更新到这些版本。

始终可以编辑 conanfiles 并显式更新到新版本,但 Conan 中存在一些机制,可以在无需修改配方的情况下允许进行此类更新。

版本范围

一个 requires 可以表达对给定包的某个版本范围的依赖,语法为 pkgname/[version-range-expression]。让我们看一个例子。请先克隆源代码以重新创建此项目。你可以在 GitHub 的 examples2 仓库 中找到它们

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/consuming_packages/versioning

我们可以看到我们有

conanfile.py
from conan import ConanFile


class CompressorRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeToolchain", "CMakeDeps"

    def requirements(self):
        self.requires("zlib/[~1.2]")

requires 包含表达式 zlib/[~1.2],这意味着“大约” 1.2 版本。这意味着,它可以解析为任何 zlib/1.2.8zlib/1.2.11zlib/1.2.12,但它不会解析为像 zlib/1.3.0 这样的版本。在可用的匹配版本中,版本范围将始终选择最新的版本。

如果我们执行 conan install,我们会看到类似的内容

$ conan install .

Graph root
    conanfile.py: .../conanfile.py
Requirements
    zlib/1.2.12#87a7211557b6690ef5bf7fc599dd8349 - Downloaded
Resolved version ranges
    zlib/[~1.2]: zlib/1.2.12

如果我们尝试使用 zlib/[<1.2.12],这意味着我们希望使用低于 1.2.12 的版本,但该版本被排除在外,因此满足范围的最新版本将是 zlib/1.2.11

$ conan install .

Resolved version ranges
    zlib/[<1.2.12]: zlib/1.2.11

同样适用于其他类型的需求,例如 tool_requires。让我们将一个添加到配方中

conanfile.py
from conan import ConanFile


class CompressorRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeToolchain", "CMakeDeps"

    def requirements(self):
        self.requires("zlib/[~1.2]")

    def build_requirements(self):
        self.tool_requires("cmake/[>3.10]")

我们看到它解析为具有至少版本 3.11 的最新的 CMake 包

$ conan install .
...
Graph root
    conanfile.py: .../conanfile.py
Requirements
    zlib/1.2.12#87a7211557b6690ef5bf7fc599dd8349 - Cache
Build requirements
    cmake/3.27.9#f305019023c2db74d1001c5afa5cf362 - Downloaded
Resolved version ranges
    cmake/[>3.10]: cmake/3.27.9
    zlib/[~1.2]: zlib/1.2.12

修订版

当包创建者对包配方或源代码进行一些更改,但他们没有更新 version 以反映这些更改时,会发生什么?Conan 具有一个内部机制来跟踪这些修改,它被称为 修订版

配方修订版是与包名称和版本一起看到的哈希值,形式为 pkgname/version#recipe_revisionpkgname/version@user/channel#recipe_revision。配方修订版是配方和源代码内容的哈希值。因此,如果配方、其关联文件或此配方打包的源代码发生任何更改,它将创建一个新的配方修订版。

你可以使用 conan list 命令列出现有的修订版

$ conan list "zlib/1.2.12#*" -r=conancenter
conancenter
  zlib
    zlib/1.2.12
      revisions
        82202701ea360c0863f1db5008067122 (2022-03-29 15:47:45 UTC)
        bd533fb124387a214816ab72c8d1df28 (2022-05-09 06:59:58 UTC)
        3b9e037ae1c615d045a06c67d88491ae (2022-05-13 13:55:39 UTC)
        ...

修订版始终解析为最新的修订版(创建或上传到服务器的顺序)。虽然这并不是一种常见的做法,但可以在 conanfile 中直接固定给定的配方修订版,例如

def requirements(self):
    self.requires("zlib/1.2.12#87a7211557b6690ef5bf7fc599dd8349")

但是,这种机制可能很繁琐,并且在创建新修订版时需要维护和更新,因此通常不应该这样做。

锁定文件

版本范围的使用,以及在不更新版本的情况下创建给定包的新修订版的能力,可以实现快速、自动和便捷的更新,而无需编辑配方。

但在某些情况下,还需要提供一组不可变且可重现的依赖项。此过程被称为“锁定”,允许它的机制是“lockfile”文件。lockfile 是一个包含固定依赖项列表的文件,指定确切的版本和确切的修订版。因此,例如,lockfile 将永远不包含带有表达式的版本范围,而只包含固定的依赖项。

可以将 lockfile 视为在某个时间点的给定依赖图的快照。该快照必须是“可实现的”,也就是说,它需要是可以从 conanfile 配方中实际重现的状态。并且可以在稍后时间点使用此 lockfile 来强制相同的状态,即使创建了新的包版本。

让我们看看 lockfile 的实际应用。首先,让我们将依赖项固定到我们的示例中的 zlib/1.2.11

def requirements(self):
    self.requires("zlib/1.2.11")

然后,让我们捕获一个 lockfile

conan lock create .

-------- Computing dependency graph ----------
Graph root
    conanfile.py: .../conanfile.py
Requirements
    zlib/1.2.11#4524fcdd41f33e8df88ece6e755a5dcc - Cache

Generated lockfile: .../conan.lock

让我们看看 lockfile conan.lock 包含的内容

{
    "version": "0.5",
    "requires": [
        "zlib/1.2.11#4524fcdd41f33e8df88ece6e755a5dcc%1650538915.154"
    ],
    "build_requires": [],
    "python_requires": []
}

现在,让我们恢复原始 requires 版本范围

def requirements(self):
    self.requires("zlib/[~1.2]")

并运行 conan install .,默认情况下会找到 conan.lock,并运行等效的 conan install . --lockfile=conan.lock

conan install .

Graph root
    conanfile.py: .../conanfile.py
Requirements
    zlib/1.2.11#4524fcdd41f33e8df88ece6e755a5dcc - Cache

请注意,版本范围不再被解析,并且即使允许的范围是 zlib/[~1.2],也不会获得 zlib/1.2.12 依赖项,因为 conan.lock lockfile 强制它停留在 zlib/1.2.11 及其确切的修订版。