产品流水线：分布式完整流水线，使用lockfiles¶

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

使用 lockfiles 来保证所有配置的一致且固定的依赖集。
将构建的包上传到 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

与我们在 packages pipeline 中想要确保不同配置和产品在构建时依赖项完全相同所做的一样，第一步是计算一个 conan.lock lockfile，我们可以将其传递给不同的 CI 构建代理，以在所有地方强制执行相同的依赖集。这可以针对不同的 products 和配置进行增量计算，最终将其聚合到单个 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 的区别。现在，我们将解释 products 流水线的“核心”：迭代构建顺序、分发构建以及收集结果构建的包。

这提供了一个示例 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 代码正在执行以下任务

对于构建顺序中的每个 package，都会发出一个 conan install --require=<pkg> --build=<pkg>，并将此命令的结果存储在 graph.json 文件中
conan list 命令将此 graph.json 转换为一个包列表，称为 built.json。请注意，此包列表实际上存储了构建的包和必要的传递依赖项。这是为了简单起见，因为稍后这些包列表将用于运行推广，我们还想推广在 packages pipeline 中构建的依赖项，例如 ai/1.1.0，而不是由此作业构建的。
conan upload 命令将包列表上传到 products 仓库。请注意，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 文件。

简化不同的发布和调试配置，我们的仓库状态将如下所示

现在，我们可以将不同的 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 版本的开发人员和 CI，仍然能够使用该依赖项而不会出现任何问题，因为新版本和包二进制文件不会破坏或使以前存在的二进制文件失效。

此时，可能会出现关于如何在 Ci 中使用 lockfile 的问题。请注意，conan.lock 现在包含锁定的 ai/1.1.0 版本。可以有不同的策略，例如将此 lockfile 存储在“products”git 仓库中，以便开发人员在签出这些仓库时可以轻松访问它。请注意，此 lockfile 与 develop 仓库的最新状态匹配，因此签出其中一个“products”git 仓库并针对 develop 服务器仓库执行 conan install 的开发人员自然会解析到 lockfile 中存储的相同依赖项。

至少将此 lockfile 存储在任何发布包中（如果“products”以某种方式打包（安装程序、debian/rpm/choco/etc 包）），以便将用于生成它的 lockfile包含或附加到最终用户的软件的发布信息中，以便以后可以从发布信息中恢复这些 lockfile，而不会受到开发仓库中更改的影响。

最终说明¶

如本 CI 教程介绍中所述，这并不假装是一种万能药，您可以按原样部署到组织中的 CI 系统。到目前为止，本教程介绍了一个开发人员的连续集成过程的“幸福路径”，以及他们对属于较大产品的包的更改如何作为这些产品的一部分进行测试和验证。

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

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

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

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

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