持续集成 (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]")，因此无需修改 recipes 即可自动使用依赖项的新补丁版本和小版本。

注意

重要说明

  • 本节内容以动手教程的形式编写。旨在通过在您的机器上复制命令来重现。

  • 本教程介绍了一些 CI 问题的工具、最佳实践和常见方法。但没有万能药。本教程并非事物应该如何做的唯一方法。不同的组织可能有不同的需求和优先事项、不同的构建服务能力和预算、不同的规模等。本教程中介绍的原则和实践可能需要进行调整。

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

  • 然而，其中一些原则和最佳实践对于所有方法都是通用的。例如，包的不可变性、在仓库之间使用提升，以及不使用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" ]; } }

提升（Promotions）是将包从一个管道提供给另一个管道的机制。将上述包和产品管道与仓库连接起来，将会有 2 次提升。

  • 当“包管道”为单个包构建了所有不同配置的二进制文件，并将它们上传到 packages 仓库后，这个包的新版本和更改就可以被认为是“正确”的，并被提升（复制）到 products 仓库。

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

注意

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

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