版本¶

本节解释如何创建给定软件包的不同版本，首先从手动更改 conanfile.py 食谱中的版本属性开始，然后引入 set_version() 方法作为自动化软件包版本定义的机制。

注意

本节使用非常简单、空的食谱，不构建任何代码，因此没有 build()、package() 等，以最简单的食谱说明版本管理，并使示例易于运行、非常快速和简单。在实际应用中，食谱将是教程前面章节中看到的完整食谱，构建实际的库和软件包。

让我们从一个非常简单的食谱开始

conanfile.py¶

from conan import ConanFile

class pkgRecipe(ConanFile):
    name = "pkg"
    version = "1.0"

    # The recipe would export files and package them, but not really
    # necessary for the purpose of this part of the tutorial
    # exports_sources = "include/*"
    # def package(self):
    #    ...

我们可以用它创建 pkg/1.0 软件包

$ conan create .
...
pkg/1.0 .
...

$ conan list "pkg/*"
Local Cache
  pkg
    pkg/1.0

如果现在我们对该库的源文件进行了一些更改，这将是一个新版本，我们可以将 conanfile.py 的版本更改为 version = "1.1" 并创建新的 pkg/1.1 版本

# Make sure you modified conanfile.py to version=1.1
$ conan create .
...
pkg/1.1 .
...

$ conan list "pkg/*"
Local Cache
  pkg
    pkg/1.0
    pkg/1.1

如我们所见，现在在缓存中可以看到 pkg/1.0 和 pkg/1.1。Conan 缓存可以为同一个 pkg 软件包存储任意数量的不同版本和配置。

自动化版本¶

除了手动更改 conanfile.py 中的版本，还可以通过两种不同的方法自动化它。

首先，可以直接在命令行中提供 version。在上面的例子中，我们可以从食谱中删除 version 属性，然后执行

# Make sure you removed the version attribute in conanfile.py
$ conan create . --version=1.2
...
pkg/1.2 .
...

$ conan list "pkg/*"
Local Cache
  pkg
    pkg/1.0
    pkg/1.1
    pkg/1.2

另一种可能性是使用 set_version() 方法动态定义版本，例如，如果版本已存在于源代码或文本文件中，或者应根据 git 版本推断。

假设我们的仓库中有一个 version.txt 文件，其中只包含版本字符串 1.3。那么，可以这样操作

conanfile.py¶

from conan import ConanFile
from conan.tools.files import  load


class pkgRecipe(ConanFile):
    name = "pkg"

    def set_version(self):
        self.version = load(self, "version.txt")

# No need to specify the version in CLI arg or in recipe attribute
$ conan create .
...
pkg/1.3 .
...

$ conan list "pkg/*"
Local Cache
  pkg
    pkg/1.0
    pkg/1.1
    pkg/1.2
    pkg/1.3

也可以结合命令行版本定义，如果命令行参数未提供，则回退到从文件读取，语法如下

conanfile.py¶

def set_version(self):
    # if self.version is already defined from CLI --version arg, it will
    # not load version.txt
    self.version = self.version or load(self, "version.txt")

# This will create the "1.4" version even if the version.txt file contains "1.3"
$ conan create . --version=1.4
...
pkg/1.4 .
...

$ conan list "pkg/*"
Local Cache
  pkg
    pkg/1.0
    pkg/1.1
    pkg/1.2
    pkg/1.3
    pkg/1.4

同样，也可以从 Git 标签获取版本

conanfile.py¶

from conan import ConanFile
from conan.tools.scm import Git

class pkgRecipe(ConanFile):
    name = "pkg"

    def set_version(self):
        git = Git(self)
        tag = git.run("describe --tags")
        self.version = tag

# assuming this is a git repo, and it was tagged to 1.5
$ git init .
$ git add .
$ git commit -m "initial commit"
$ git tag 1.5
$ conan create .
    ...
    pkg/1.5 .
    ...

$ conan list "pkg/*"
Local Cache
  pkg
    pkg/1.0
    pkg/1.1
    pkg/1.2
    pkg/1.3
    pkg/1.4
    pkg/1.5

注意

最佳实践

我们可以尝试使用诸如分支名称或提交作为版本号。然而，这可能有一些缺点，例如，当需要此软件包时，每个需要此软件包的其他软件包食谱都需要明确的 requires = "pkg/commit"，这可能导致消费者难以一致地更新，并且难以知道使用的是较新还是较旧的依赖。

要求新版本¶

当创建新软件包版本时，如果其他需要此软件包的食谱包含明确的 requires，精确固定版本，例如

app/conanfile.py¶

from conan import ConanFile

class AppRecipe(ConanFile):
    name = "app"
    version = "1.0"
    requires = "pkg/1.0"

那么，安装或创建 app 食谱将继续要求并使用 pkg/1.0 版本而不是更新的版本。要开始使用新的 pkg 版本，需要明确更新 requires，例如

app/conanfile.py¶

from conan import ConanFile

class AppRecipe(ConanFile):
    name = "app"
    version = "1.0"
    requires = "pkg/1.5"

这个过程虽然实现了很好的可复现性和可追溯性，但如果管理大型依赖图，并且希望更快、更少手动干预地使用最新的依赖版本，这可能会有点繁琐。为了自动化此过程，可以使用下一节中解释的版本范围。