持续集成 (CI) 教程

注意

  • 这是一个高级主题，需要具备 Conan 的先验知识。请先阅读并实践用户教程。

  • 本节面向设计和实现涉及 Conan 包的 CI 流水线的 DevOps 和构建工程师，如果情况并非如此，您可以跳过本节。

持续集成对不同的用户和组织有不同的含义。在本教程中，我们将涵盖以下场景：用户对包的源代码进行更改，并希望自动构建这些包的新二进制文件，同时计算这些新的包更改是否能干净地集成，或者是否会破坏组织的主要产品。

在本教程中，我们将使用这个小型项目，它使用多个包（默认为静态库）来构建两个应用程序：一个视频游戏和一个地图查看器工具。game 和 mapviewer 是我们最终的“产品”，即我们分发给用户的那些

digraph game { node [fillcolor="lightskyblue", style=filled, shape=box] rankdir="BT" "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"]; { rank = same; edge[ style=invis]; "game/1.0" -> "mapviewer/1.0" ; rankdir = LR; } }

依赖图中的所有包都使用版本范围对其直接依赖项进行了 requires，例如，game 包含一个 requires("engine/[>=1.0 <2]")，因此依赖项的新补丁版本和次要版本将自动使用，无需修改配方。

注意

重要提示

  • 本节旨在作为动手教程。它旨在通过复制机器上的命令进行复现。

  • 本教程介绍了一些用于解决 CI 问题的工具、良好实践和常见方法。但没有一劳永逸的解决方案。本教程并非唯一可行的方法。不同的组织可能有不同的需求和优先级，不同的构建服务能力和预算，不同的规模等。教程中介绍的原则和实践可能需要进行调整。

  • 如果您有任何问题或反馈，请在 https://github.com/conan-io/conan/issues 提交新问题

  • 然而，一些原则和最佳实践适用于所有方法。例如包的不可变性、在不同仓库之间使用提升机制而不是为此目的使用 channel，这些都是应该遵循的良好实践。

包与产品流水线

当开发人员对包的源代码进行更改时，我们将考虑整个系统 CI 的两个不同部分或流水线：包流水线 和 产品流水线

  • 包流水线 负责在代码更改时构建单个包。如有必要，它会为不同的配置进行构建。

  • 产品流水线 负责构建组织的主要“产品”（实现最终应用程序或交付物的包），并确保依赖项中的更改和新版本能够正确集成，如有必要，重新构建图中的任何中间包。

其理念是，如果某个开发人员更改了 ai 包，生成了新的 ai/1.1.0 版本，包流水线将首先构建这个新版本。但这个新版本可能会意外地破坏或需要重新构建一些消费者包。如果我们的组织主要产品是 game/1.0 和 mapviewer/1.0，那么产品流水线可以被触发，在这种情况下，它将重建 engine/1.0 和 game/1.0，因为它们受到了更改的影响。

仓库与提升机制

多服务器端仓库的概念对于 CI 非常重要。在本教程中，我们将使用 3 个仓库

  • develop：此仓库是开发人员在其机器中配置的主要仓库，以便能够 conan install 依赖项并进行工作。因此，它预期会非常稳定，类似于 Git 中的共享“develop”分支，并且该仓库应包含组织预定义平台的预编译二进制文件，这样开发人员和 CI 就不需要执行 --build=missing 并反复从源代码构建。

  • packages：此仓库将用于临时上传“包流水线”构建的包，以避免直接上传到 develop 仓库并在这些包完全验证之前造成干扰。

  • products：此仓库将用于临时上传“产品流水线”构建的包，同时构建和测试新的依赖项更改不会破坏主要的“产品”。

digraph repositories { node [fillcolor="lightskyblue", style=filled, shape=box] rankdir="LR"; subgraph cluster_0 { style=filled; color=lightgrey; rankdir="LR"; label = "Packages server"; "packages\n repository" -> "products\n repository" -> "develop\n repository" [ label="promotion" ]; } }

提升机制是用于使包从一个流水线可用于另一个流水线的机制。将上述包流水线和产品流水线与仓库连接起来，将有 2 种提升机制

  • 当单个包在 packages pipeline 中为不同配置构建了所有不同的二进制文件，并上传到 packages 仓库后，该包的新版本和更改可以被视为“正确”的，并提升（复制）到 products 仓库。

  • 当 products pipeline 由于 products 仓库中新的包版本而从源代码构建了所有需要重新构建的必要包，并检查了组织“产品”（如 game/1.0 和 mapviewer/1.0）没有损坏时，那么这些包就可以从 products 仓库提升（复制）到 develop 仓库，以便所有其他开发人员和 CI 使用。

注意

本教程仅模拟开发流程。在生产系统中，将会有其他仓库和提升机制，例如用于 QA 团队的 testing 仓库，以及用于最终用户的最终 release 仓库，这样包可以通过验证后从 develop 提升到 testing 再到 release。有关提升机制的更多信息，请阅读 包提升机制。

让我们开始教程，移步下一节进行项目设置