产品流水线：构建顺序

上一节使用 --build=missing 在同一台 CI 机器上构建所有必要的包。这并不总是期望的，甚至可能无法实现，在许多情况下，进行分布式构建是更优的选择，以实现更快的构建速度和更好的 CI 资源利用率。构建负载最自然的分布方式是在不同的机器上构建不同的包。让我们看看如何使用 conan graph build-order 命令来实现这一点。

让我们像往常一样从确保我们拥有一个干净的环境和正确的仓库定义开始

# 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

现在我们暂时忽略 mapviewer/1.0 产品，并将本节的重点放在 game/1.0 产品上。第一步是计算“构建顺序”，即需要构建的包的列表以及它们的构建顺序。这可以使用以下 conan graph build-order 命令来完成

$ conan graph build-order --requires=game/1.0 --build=missing --order-by=recipe --reduce --format=json > game_build_order.json

需要注意几个重要事项

  • 必须使用 --build=missing，方式与上一节完全相同。未能提供预期的 --build 策略和参数将导致不完整或错误的构建顺序。

  • --reduce 参数消除了结果顺序中所有不具有 binary: Build 策略的元素。这意味着生成的“构建顺序”不能与其他构建顺序文件合并以将它们聚合到一个文件中，这在存在多个配置和产品时非常重要。

  • --order-by 参数允许定义不同的顺序，按“recipe”或按“configuration”。在这种情况下，我们使用 --order-by=recipe，其目的是并行化每个 recipe 的构建，这意味着对于给定的包（例如 engine/1.0），应该首先构建所有可能的二进制文件，然后才能构建任何依赖于 engine/1.0 的消费者。

生成的 game_build_order.json 文件如下所示

game_build_order.json
  {
      "order_by": "recipe",
      "reduced": true,
      "order": [
          [
              {
                  "ref": "engine/1.0#fba6659c9dd04a4bbdc7a375f22143cb",
                  "packages": [
                      [
                          {
                              "package_id": "de738ff5d09f0359b81da17c58256c619814a765",
                              "binary": "Build",
                              "build_args": "--requires=engine/1.0 --build=engine/1.0",
                          }
                      ]
                  ]
              }
          ],
          [
              {
                  "ref": "game/1.0#1715574045610faa2705017c71d0000e",
                  "depends": [
                      "engine/1.0#fba6659c9dd04a4bbdc7a375f22143cb"
                  ],
                  "packages": [
                      [
                          {
                              "package_id": "bac7cd2fe1592075ddc715563984bbe000059d4c",
                              "binary": "Build",
                              "build_args": "--requires=game/1.0 --build=game/1.0",
                          }
                      ]
                  ]
              }
          ]
      ]
  }

为了方便起见，就像 conan graph info ... --format=html > graph.html 可以生成包含 HTML 交互式依赖关系图的文件一样，conan graph build-order ... --format=html > build_order.html 可以生成上述 json 文件的 HTML 可视化表示。

../../_images/build_order_simple.png

生成的 json 文件包含一个 order 元素，它是一个列表的列表。这种安排很重要，顶级列表中的每个元素都是一组可以并行构建的包，因为它们之间没有关系。您可以将此列表视为一个“级别”列表，在级别 0 中，有无依赖于任何其他正在构建的包的包，在级别 1 中，有仅依赖于级别 0 中元素的包，依此类推。

然后，外层列表中的元素的顺序很重要，必须遵守。在构建一个列表项中的所有包完成之前，无法开始构建下一个“级别”。

使用 graph_build_order.json 文件中的信息，可以执行必要的包的构建，方式与上一节的 --build=missing 相同，但不再由我们直接管理。

获取 json 中的参数后，要执行的命令将是

$ conan install --requires=engine/1.0 --build=engine/1.0
$ conan install --requires=game/1.0 --build=game/1.0

我们正在手动执行这些命令，但在实践中，这将是在 CI 中遍历 json 输出的 for 循环。稍后我们将看到一些 Python 代码。目前我们想专注于 conan graph build-order 命令，但我们还没有真正解释如何分配构建。

另外请注意，在每个元素内部，有一个内部的列表的列表，"packages" 部分，用于必须为不同配置的特定 recipe 构建的所有二进制文件。

现在让我们看看如何计算多产品、多配置的构建顺序。