包流水线:使用锁定文件进行多配置

在前面的示例中,我们为 ai/1.1.0 构建了 DebugRelease 包二进制文件。在实际场景中,要构建的二进制文件会是不同的平台(Windows、Linux、嵌入式)、不同的架构,而且通常不可能在同一台机器上构建它们,需要不同的计算机。

前面的示例有一个重要假设:ai/1.1.0 的依赖项在构建过程中完全不会改变。在许多情况下,这个假设不会成立,例如,如果有其他并发的 CI 任务,并且一个成功的任务在 develop 仓库中发布了新的 mathlib/1.1 版本。

那么,ai/1.1.0 的某个构建,例如在 Linux 服务器上运行的构建,可能会更早启动并使用以前的 mathlib/1.0 版本作为依赖,而 Windows 服务器稍晚启动,然后它们的构建将使用最近的 mathlib/1.1 版本作为依赖。这是一种非常不理想的情况,对于相同的 ai/1.1.0 版本,其二进制文件使用了不同的依赖版本。这可能导致后续的图解析问题,甚至更糟的是,在发布时不同平台具有不同的行为。

避免这种依赖项差异的方法是强制使用相同的依赖项版本和修订版,这可以通过锁定文件来完成。

创建和应用锁定文件相对简单。创建和提升配置的过程与上一节相同,只是应用了锁定文件。

创建锁定文件

像往常一样,我们先确保从一个干净的状态开始

$ conan remove "*" -c  # Make sure no packages from last run

然后我们可以创建锁定文件 conan.lock

# Capture a lockfile for the Release configuration
$ conan lock create . -s build_type=Release --lockfile-out=conan.lock
# extend the lockfile so it also covers the Debug configuration
# in case there are Debug-specific dependencies
$ conan lock create . -s build_type=Debug --lockfile=conan.lock --lockfile-out=conan.lock

请注意,使用不同配置文件或设置的不同配置可能会导致不同的依赖图。锁定文件可以用于锁定不同的配置,但重要的是要遍历不同的配置/配置文件,并将其信息捕获到锁定文件中。

注意

conan.lock 是默认参数,如果 conan.lock 文件存在,它可能会被 conan install/create 和其他图命令自动使用。这可以简化许多命令,但本教程为了清晰和教学目的,展示了完整的显式命令。

conan.lock 文件可以检查,它会是这样的:

{
    "version": "0.5",
    "requires": [
        "mathlib/1.0#f2b05681ed843bf50d8b7b7bdb5163ea%1724319985.398"
    ],
    "build_requires": [],
    "python_requires": [],
    "config_requires": []
}

如我们所见,它锁定了 mathlib/1.0 的依赖版本和修订版。

有了锁定文件,创建不同配置的方式完全相同,但通过向 conan create 步骤提供 --lockfile=conan.lock 参数,它将保证 mathlib/1.0#f2b05681ed843bf50d8b7b7bdb5163ea 永远是使用的确切依赖项,无论是否存在新的 mathlib/1.1 版本或新的可用修订版。以下构建可以并行启动但执行时间不同,它们仍然会始终使用相同的 mathlib/1.0 依赖项

Release 构建
$ cd ai  # If you were not inside "ai" folder already
$ conan create . --build="missing:ai/*" --lockfile=conan.lock -s build_type=Release --format=json > graph.json
$ conan list --graph=graph.json --graph-binaries=build --format=json > built.json
$ conan remote enable packages
$ conan upload -l=built.json -r=packages -c --format=json > uploaded_release.json
$ conan remote disable packages
Debug 构建
$ conan create . --build="missing:ai/*" --lockfile=conan.lock -s build_type=Debug --format=json > graph.json
$ conan list --graph=graph.json --graph-binaries=build --format=json > built.json
$ conan remote enable packages
$ conan upload -l=built.json -r=packages -c --format=json > uploaded_debug.json
$ conan remote disable packages

请注意,与上一个示例的唯一修改是添加了 --lockfile=conan.lock。提升过程也将与上一个示例相同

从 packages->product 提升
# aggregate the package list
$ conan pkglist merge -l uploaded_release.json -l uploaded_debug.json --format=json > uploaded.json

$ conan remote enable packages
$ conan remote enable products
# Promotion using Conan download/upload commands
# (slow, can be improved with art:promote custom command)
$ conan download --list=uploaded.json -r=packages --format=json > promote.json
$ conan upload --list=promote.json -r=products -c
$ conan remote disable packages
$ conan remote disable products

最终结果将与上一节相同,但这次保证了 DebugRelease 二进制文件都使用了完全相同的 mathlib 版本构建。

digraph repositories { node [fillcolor="lightskyblue", style=filled, shape=box] rankdir="LR"; subgraph cluster_0 { label="Packages server"; style=filled; color=lightgrey; subgraph cluster_1 { label = "packages\n repository" shape = "box"; style=filled; color=lightblue; "packages" [style=invis]; "ai/1.1.0\n (Release)"; "ai/1.1.0\n (Debug)"; } subgraph cluster_2 { label = "products\n repository" shape = "box"; style=filled; color=lightblue; "products" [style=invis]; "ai/promoted release" [label="ai/1.1.0\n (Release)"]; "ai/promoted debug" [label="ai/1.1.0\n (Debug)"]; } subgraph cluster_3 { rankdir="BT"; shape = "box"; label = "develop repository"; color=lightblue; rankdir="BT"; node [fillcolor="lightskyblue", style=filled, shape=box] "game/1.0" -> "engine/1.0" -> "ai/1.0" -> "mathlib/1.0"; "engine/1.0" -> "graphics/1.0" -> "mathlib/1.0"; "mapviewer/1.0" -> "graphics/1.0"; "game/1.0" [fillcolor="lightgreen"]; "mapviewer/1.0" [fillcolor="lightgreen"]; } { edge[style=invis]; "packages" -> "products" -> "game/1.0" ; rankdir="BT"; } } }

现在我们已经将新的 ai/1.1.0 二进制文件放入 products 仓库,我们可以认为 packages pipeline 已完成,并进入下一节,构建并检查我们的产品,以查看这个新的 ai/1.1.0 版本是否正确集成。