产品流水线：带 lockfile 的分布式完整流水线¶

本节将介绍多产品、多配置分布式 CI 流水线的完整实现。它将涵盖重要的实现细节

使用 lockfile 保证所有配置的依赖项集一致且固定。
将构建好的包上传到 products 仓库。
捕获“包列表”并使用它们运行最终的推广。
如何以编程方式遍历“构建顺序”

像往常一样，先清理本地缓存并定义正确的仓库

# First clean the local "build" folder
$ pwd  # should be <path>/examples2/ci/game
$ rm -rf build  # clean the temporary build folder
$ mkdir build && cd build # To put temporary files

$ conan remove "*" -c  # Make sure no packages from last run
# NOTE: The products repo is first, it will have higher priority.
$ conan remote enable products

类似于我们在 包流水线 中所做的，当我们想要确保在构建不同配置和产品时依赖项完全一致，第一步是计算一个 conan.lock lockfile，我们可以将其传递给不同的 CI 构建代理，以便在任何地方强制使用相同的依赖项集。这可以针对不同的 产品 和配置增量完成，并将其聚合到最终的单个 conan.lock lockfile 中。这种方法假设 game/1.0 和 mapviewer/1.0 将使用相同版本和修订的公共依赖项。

$ conan lock create --requires=game/1.0 --lockfile-out=conan.lock
$ conan lock create --requires=game/1.0 -s build_type=Debug --lockfile=conan.lock --lockfile-out=conan.lock
$ conan lock create --requires=mapviewer/1.0 --lockfile=conan.lock --lockfile-out=conan.lock
$ conan lock create --requires=mapviewer/1.0 -s build_type=Debug --lockfile=conan.lock --lockfile-out=conan.lock

注意

请注意，conan.lock 参数大多是可选的，因为它是默认的 lockfile 名称。第一个命令可以输入为 conan lock create --requires=game/1.0。此外，所有命令，包括 conan install，如果找到现有的 conan.lock 文件，它们将自动使用它，无需显式指定 --lockfile=conan.lock。本教程中的命令为了完整性和教学目的而明确显示完整形式。

然后，我们可以计算每个产品和配置的构建顺序。这些命令与上一节中的命令相同，唯一的区别是增加了 --lockfile=conan.lock 参数

$ conan graph build-order --requires=game/1.0 --lockfile=conan.lock --build=missing --order-by=recipe --format=json > game_release.json
$ conan graph build-order --requires=game/1.0 --lockfile=conan.lock --build=missing -s build_type=Debug --order-by=recipe --format=json > game_debug.json
$ conan graph build-order --requires=mapviewer/1.0 --lockfile=conan.lock --build=missing --order-by=recipe --format=json > mapviewer_release.json
$ conan graph build-order --requires=mapviewer/1.0 --lockfile=conan.lock --build=missing -s build_type=Debug --order-by=recipe --format=json > mapviewer_debug.json

同样，build-order-merge 命令也将与前一个命令相同。在这种情况下，由于此命令实际上并不计算依赖关系图，因此不需要 conan.lock 参数，依赖关系没有得到解析

$ conan graph build-order-merge --file=game_release.json --file=game_debug.json --file=mapviewer_release.json --file=mapviewer_debug.json --reduce --format=json > build_order.json

到目前为止，这个过程与上一节几乎相同，只是增加了捕获和使用 lockfile 的区别。现在，我们将解释 产品 流水线的“核心”：遍历构建顺序并分发构建，以及收集生成的构建包。

这是一个执行顺序遍历的 Python 代码示例（真实的 CI 系统会将构建分发到不同的代理并行执行）

build_order = open("build_order.json", "r").read()
build_order = json.loads(build_order)
to_build = build_order["order"]

pkg_lists = []  # to aggregate the uploaded package-lists
for level in to_build:
    for recipe in level:  # This could be executed in parallel
        ref = recipe["ref"]
        # For every ref, multiple binary packages are being built.
        # This can be done in parallel too. Often it is for different platforms
        # they will need to be distributed to different build agents
        for packages_level in recipe["packages"]:
            # This could be executed in parallel too
            for package in packages_level:
                build_args = package["build_args"]
                filenames = package["filenames"]
                build_type = "-s build_type=Debug" if any("debug" in f for f in filenames) else ""
                run(f"conan install {build_args} {build_type} --lockfile=conan.lock --format=json", file_stdout="graph.json")
                run("conan list --graph=graph.json --format=json", file_stdout="built.json")
                filename = f"uploaded{len(pkg_lists)}.json"
                run(f"conan upload -l=built.json -r=products -c --format=json", file_stdout=filename)
                pkg_lists.append(filename)

注意

此代码是针对 --order-by=recipe 构建顺序的特定代码，如果选择 --order-by=configuration，则 json 结构不同，需要不同的遍历方式。

上面 Python 代码执行的任务如下

对于构建顺序中的每个 包，都会执行一个 conan install --require=<pkg> --build=<pkg> 命令，该命令的结果存储在 graph.json 文件中
从 graph.json 中提取 conan list 命令将 graph.json 转换为一个名为 built.json 的包列表。请注意，这个包列表实际上存储了构建的包和必要的传递依赖项。这样做是为了简化，因为稍后这些包列表将用于运行推广，而且我们还希望推广像 ai/1.1.0 这样在 包流水线 中构建而不是由当前任务构建的依赖项。
将包列表上传到 products 仓库 conan upload 命令将包列表上传到 products 仓库。请注意，upload 命令首先检查仓库中已存在的包，从而避免在包已存在时进行耗时的传输。
捕获 conan upload 命令的结果 conan upload 命令的结果被捕获在一个新的包列表文件中，名为 uploaded<index>.json，我们稍后会将其累积起来，用于最终的推广。

实际上，这转化为以下命令（您可以执行这些命令以继续本教程）

# engine/1.0 release
$ conan install --requires=engine/1.0 --build=engine/1.0 --lockfile=conan.lock --format=json > graph.json
$ conan list --graph=graph.json --format=json > built.json
$ conan upload -l=built.json -r=products -c --format=json > uploaded1.json

# engine/1.0 debug
$ conan install --requires=engine/1.0 --build=engine/1.0 --lockfile=conan.lock -s build_type=Debug --format=json > graph.json
$ conan list --graph=graph.json --format=json > built.json
$ conan upload -l=built.json -r=products -c --format=json > uploaded2.json

# game/1.0 release
$ conan install --requires=game/1.0 --build=game/1.0 --lockfile=conan.lock --format=json > graph.json
$ conan list --graph=graph.json --format=json > built.json
$ conan upload -l=built.json -r=products -c --format=json > uploaded3.json

# game/1.0 debug
$ conan install --requires=game/1.0 --build=game/1.0 --lockfile=conan.lock -s build_type=Debug --format=json > graph.json
$ conan list --graph=graph.json --format=json > built.json
$ conan upload -l=built.json -r=products -c --format=json > uploaded4.json

完成此步骤后，新构建的包将位于 products 仓库中，我们将拥有 4 个文件，分别为 uploaded1.json - uploaded4.json。

简化不同 release 和 debug 配置后，我们的仓库状态将如下所示

现在我们可以将不同的 uploadedX.json 文件累积到一个包含所有内容的包列表文件 uploaded.json 中

$ conan pkglist merge -l uploaded0.json -l uploaded1.json -l uploaded2.json -l uploaded3.json --format=json > uploaded.json

最后，如果一切顺利，并且我们认为这组新版本和新包二进制文件已准备好供开发者和其他 CI 作业使用，那么我们可以运行从 products 仓库到 develop 仓库的最终推广操作

从 products 推广到 develop¶

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

我们的最终 develop 仓库状态将是

这种 develop 仓库状态将具有以下行为

开发者安装 game/1.0 或 engine/1.0 时，默认会解析并使用最新的 ai/1.1.0。他们也将找到依赖项的预编译二进制文件，并且可以继续使用最新的依赖项集进行开发。
使用锁定 ai/1.0 版本的 lockfile 的开发者和 CI 将仍能继续使用该依赖项而不会出现任何问题，因为新版本和包二进制文件不会破坏或使先前存在的二进制文件失效。

此时，可能会出现关于如何处理 CI 中使用的 lockfile 的问题。请注意，conan.lock 现在包含锁定的 ai/1.1.0 版本。可以有不同的策略，例如将此 lockfile 存储在“产品”的 Git 仓库中，以便开发者拉取这些仓库时可以轻松获取。但是请注意，此 lockfile 与 develop 仓库的最新状态匹配，因此开发者在拉取某个“产品”的 Git 仓库并对 develop 服务器仓库执行 conan install 时，自然会解析到 lockfile 中存储的相同依赖项。

如果“产品”以某种方式（安装程序、debian/rpm/choco 等包）打包发布，最好至少将此 lockfile 存储在任何发布包中，并包含或附加到此打包发布中，供软件的最终用户使用。这样做是为了记录用于生成该产品的 lockfile，以便无论开发仓库发生什么变化，将来都可以从发布信息中恢复这些 lockfile。

总结¶

正如本 CI 教程简介中所述，这并非万灵药，也不是您可以直接在您的组织中部署的 CI 系统。本教程迄今为止介绍了开发者持续集成过程的“理想路径”，以及如何将他们在作为大型产品一部分的包中所做的更改作为这些产品的一部分进行测试和验证。

本 CI 教程的重点是介绍一些重要的概念、最佳实践和工具，例如

定义组织“产品”的重要性，即需要针对开发者创建的新依赖项版本进行检查和构建的主要交付物。
在验证之前，开发者创建的新依赖项版本不应上传到主要的开发仓库，以免破坏其他开发者和 CI 作业。
如何使用多个仓库构建 CI 流水线，以隔离未经验证的更改和新版本。
如何使用 conan graph build-order 在 CI 中高效构建大型依赖关系图，以及如何将不同配置和产品的构建顺序合并在一起。
在存在并发 CI 构建时，为什么 lockfiles 在 CI 中是必要的。
版本控制的重要性，以及 package_id 在大型依赖关系图中仅重新构建必要部分的作用。
不使用 user/channel 作为在 CI 流水线中变化的包的可变和动态限定符，而是使用不同的服务器仓库。
在新包版本验证后，跨服务器仓库运行包推广（复制）。

本教程尚未涵盖许多实现细节、策略、用例和错误场景

如何集成需要新的破坏性主版本的包的破坏性更改。
不同的版本控制策略，例如使用预发布版本、使用版本或在某些情况下依赖于配方修订。
lockfile 如何跨不同构建存储和使用，以及是否应该持久化它们以及存储在哪里。
不同的分支和合并策略，夜间构建，发布流程。

我们计划扩展本 CI 教程，包含更多示例和用例。如果您有任何问题或反馈，请在 https://github.com/conan-io/conan/issues 创建一个工单。