产品流水线：构建顺序

上一节使用了 --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 参数允许通过“配方”或“配置”定义不同的顺序。在这种情况下，我们使用 --order-by=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" 部分，用于针对不同配置，特定配方必须构建的所有二进制文件。

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