修订¶

本节介绍如何在不显式创建新版本的情况下修改给定的配方或源代码，但仍然会使用一种称为“修订”的机制在内部跟踪这些更改。

创建不同的修订¶

让我们从一个基本的“hello”包开始

$ mkdir hello && cd hello
$ conan remove hello* -c # clean possible existing ones
$ conan new cmake_lib -d name=hello -d version=1.0
$ conan create .
hello/1.0: Hello World Release!
...

我们现在可以列出缓存中现有的配方修订

$ conan list "hello/1.0#*"
Local Cache
  hello
    hello/1.0
      revisions
        2475ece651f666f42c155623228c75d2 (2023-01-31 23:08:08 UTC)

如果我们现在编辑 src/hello.cpp 文件，将输出消息从“Hello”更改为“Bye”

hello/src/hello.cpp¶

void hello(){

    #ifdef NDEBUG
    std::cout << "hello/1.0: Bye World Release!\n";
    ...

因此，如果我们再次创建包，而不更改版本 hello/1.0，我们将获得新的输出

$ conan create .
hello/1.0: Bye World Release!
...

但即使版本相同，在内部也创建了一个新的修订 2b547b7f20f5541c16d0b5cbcf207502。

$ conan list "hello/1.0#*"
Local Cache
  hello
    hello/1.0
      revisions
        2475ece651f666f42c155623228c75d2 (2023-01-31 23:08:08 UTC)
        2b547b7f20f5541c16d0b5cbcf207502 (2023-01-31 23:08:25 UTC)

此配方修订是配方内容（包括 conanfile.py）和导出的源文件（src/main.cpp、CMakeLists.txt 等，即配方中导出的所有文件）的哈希值。

我们现在可以编辑 conanfile.py 文件，定义 license 的值

hello/conanfile.py¶

class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    # Optional metadata
    license = "MIT"
    ...

因此，如果我们再次创建包，输出将相同，但我们也会得到一个新的修订，因为 conanfile.py 文件已更改

$ conan create .
hello/1.0: Bye World Release!
...
$ conan list "hello/1.0#*"
Local Cache
  hello
    hello/1.0
      revisions
        2475ece651f666f42c155623228c75d2 (2023-01-31 23:08:08 UTC)
        2b547b7f20f5541c16d0b5cbcf207502 (2023-01-31 23:08:25 UTC)
        1d674b4349d2b1ea06aa6419f5f99dd9 (2023-01-31 23:08:34 UTC)

重要

配方修订是内容的哈希值。可以通过 revision_mode = "scm" 将其更改为 Git 提交哈希值。但无论如何，每个修订都代表一个不可变的源（包括配方和源代码）都是至关重要的。

如果源文件通过 exports_sources 进行管理，那么它们将自动成为哈希的一部分
如果源文件是从外部位置检索的，例如下载的 tarball 或 git clone，则应通过强制检出唯一的不可变标签或提交来确保唯一性。分支名称或 HEAD 等移动目标将失效，因为修订被认为是不可变的。

源文件或配方的任何更改都应始终意味着新的修订。

警告

行尾问题

Git 默认会在 Windows 系统上使用 CRLF 行尾检出文件。这会导致文件与 Linux 系统（其中文件使用 LF 行尾）不同。由于文件不同，在 Windows 上计算的 Conan 配方修订将与 Linux 等其他平台上的修订不同。请在FAQ 专用部分中了解有关此问题及其解决方案的更多信息。

使用修订¶

配方修订默认解析为每个给定版本的最新修订。以上述情况为例，我们可以有一个 chat/1.0 包，它使用了上面的 hello/1.0 包

$ cd ..
$ mkdir chat && cd chat
$ conan new cmake_lib -d name=chat -d version=1.0 -d requires=hello/1.0
$ conan create .
...
Requirements
chat/1.0#17b45a168519b8e0ed178d822b7ad8c8 - Cache
hello/1.0#1d674b4349d2b1ea06aa6419f5f99dd9 - Cache
...
hello/1.0: Bye World Release!
chat/1.0: Hello World Release!

我们可以看到，默认情况下，它解析到最新修订 1d674b4349d2b1ea06aa6419f5f99dd9，因此我们也看到了 hello/1.0: Bye World 修改后的消息。

可以在配方中显式依赖某个给定的修订，因此可以修改 chat/1.0 配方来定义它需要第一个创建的修订

chat/conanfile.py¶

def requirements(self):
    self.requires("hello/1.0#2475ece651f666f42c155623228c75d2")

因此，创建 chat 现在将强制使用第一个修订

$ conan create .
...
Requirements
chat/1.0#12f87e1b8a881da6b19cc7f229e16c76 - Cache
hello/1.0#2475ece651f666f42c155623228c75d2 - Cache
...
hello/1.0: Hello World Release!
chat/1.0: Hello World Release!

注意

请注意，在使用版本范围时固定修订无效，Conan 会对此发出警告。

上传修订¶

upload 命令默认只上传最新的修订

# upload latest revision only, all package binaries
$ conan upload hello/1.0 -c -r=myremote

如果出于某种原因我们想上传所有现有的修订，可以使用

# upload all revisions, all binaries for each revision
$ conan upload hello/1.0#* -c -r=myremote

在服务器端，上传的最新修订成为最新的修订，也是默认解析的修订。因此，上述命令按顺序（从旧修订到最新修订）上传不同的修订，从而在服务器端保留修订的相对顺序。

请注意，如果另一台机器决定上传很久以前创建的修订，它仍然会在服务器端成为最新的，因为它是在服务器端以该时间创建的。

包修订¶

创建的包二进制文件也会计算其内容的哈希值，形成包修订。但它们与配方修订的性质非常不同。配方修订是自然预期的，源代码或配方的任何更改都会导致新的配方修订。但包二进制文件不应超过一个包修订，因为二进制变异已编码在唯一的 package_id 中。换句话说，如果配方修订相同（完全相同的输入配方和源代码）且 package_id 相同（完全相同的配置配置文件、设置等），则该二进制文件应只构建一次。

由于 C 和 C++ 构建不是确定性的，因此即使不修改任何内容，后续构建相同的包也可能创建新的包修订。

# Build again 2 times the latest
$ conan create .
$ conan create .

在 Windows 等某些操作系统上，此构建将不可重现，并且生成的工件将具有不同的校验和，从而导致新的包修订。

$ conan list "hello/1.0:*#*"
Local Cache
  hello
    hello/1.0
      revisions
        1d674b4349d2b1ea06aa6419f5f99dd9 (2023-02-01 00:03:29 UTC)
          packages
            2401fa1d188d289bb25c37cfa3317e13e377a351
              revisions
                8b8c3deef5ef47a8009d4afaebfe952e (2023-01-31 23:08:40 UTC)
                8e8d380347e6d067240c4c00132d42b1 (2023-02-01 00:03:12 UTC)
                c347faaedc1e7e3282d3bfed31700019 (2023-02-01 00:03:35 UTC)
              info
                settings
                arch: x86_64
                build_type: Release
                ...

默认情况下，包修订也将解析为最新的。但是，无法在配方中显式固定包修订，配方只能向下要求到配方修订，如上所述。

警告

最佳实践

对于任何给定的配方修订 + package_id 存在多个包修订都是一种异味或潜在的不良实践。这意味着在不必要的情况下重新构建了某些内容，浪费了计算和存储资源。有办法避免这样做，例如 conan create . --build=missing:hello* 将仅在包二进制文件不存在时构建它（或者运行 conan graph info 也可以返回有关需要构建的内容的信息）。