返回资讯中心
外部精选
软件工程
#开发者实时流

dotnet-affected 工具可只构建 .NET monorepo 中变更的项目

来源标题:Build only what changed in your .NET monorepo with dotnet-affected

dotnet-affected 能识别 .NET monorepo 中实际发生变更的项目,从而只构建这些项目。作者所在团队一周触发 41 次流水线,其中 36 次构建了未变更的应用;跳过这些构建可节省约 400 个 agent 分钟(总计 480 分钟),并减少构建队列堵塞、加快 PR 合并。

Hacker News 最新birdculture2026/11/21 · 今天30 分钟阅读

以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。

在我目前的客户那里,属于同一个项目的所有应用都放在一个 monorepo 里,也就是一个包含多个项目的仓库,而不是每个仓库只放一个“可部署”应用。在我这个案例中,这个仓库包含一些 API、一个 Web 前端和一个桌面应用,以及它们使用的共享库,全部都是 C# 和 .NET 代码。每个应用都有自己的流水线,而每条流水线都会在 src/ 下发生任何变更时触发。只要 Web 前端里改一行,所有 API 也要跑完整个流程,因为流水线无法判断它们其实没有任何变化。

这让团队里的每个人都感到沮丧。一周之内,推送到主分支触发了 41 次流水线运行。其中 36 次构建并部署了一个根本没有变化的应用。如果跳过这些运行,我们本可以节省那一周 480 个 agent 分钟中的约 400 个。这意味着我们本可以更快地合并 PR,因为我们的构建 agent 数量有限,而构建队列经常被不必要的运行堵塞。

这个概念并不新鲜。网上已经有关于在 monorepo 中只构建变更内容的文章。然而,它们通常有以下缺点之一:

这并不意味着那些文章没有价值;它们提供了有用的见解和方法,对您的用例来说可能已经足够。尽管如此,我还是希望我的 CI 能在不需要持续关注或维护的情况下正常工作。幸运的是,有一种更好的方法可以直接在构建系统内识别受影响的プロジェクト。

在本文中,我将展示我如何用 dotnet-affected 解决这个问题,而且没有上述任何缺点:每条流水线首先询问其应用是否受到变更影响,如果没有受到影响,就跳过剩余的运行。一次快速检查,节省大量时间。

我是在 r/moderndotnet 子版块上提问后了解到这个项目的。感谢社区,特别是 u/bupsnark,为这个想法埋下了种子。

我在本文中使用 Azure Pipelines,但这种方法应该也适用于其他 CI 系统。让您的 agent 阅读本文,以获取将步骤适配到您的 CI 系统的指导,或者随时联系我。

您的仓库也可能不仅仅包含 .NET 代码,例如前端代码。只要它们与 .NET 项目相关,比如位于 wwwroot 目录中,或者在项目文件中通过 <None Include="FrontendCode/**" /> MSBuild 项包含,dotnet-affected 也能检测到这些变更。

如果您不满足这些条件,您需要修改脚本,同时使用 dotnet-affected 和其他工具来检测仓库中非 .NET 部分的变更。网上有很多关于这方面的博客文章,所以我在这里不再赘述。

让我们从头开始。您首先会考虑的解决方案可能是路径过滤器,它允许您根据仓库中特定路径的变更来触发流水线。

“我们就不能让 Orders 流水线在 src/Orders/ 中有变化时才运行吗?”

好问题!但遗憾的是,不行。一旦您共享代码,这就会失效。Orders API 引用了 src/Shared/Pricing,所以那里的变更也应该构建 Orders。您可以将该路径添加到过滤器中,但现在您要在 YAML 中维护项目引用的第二份副本,而且当添加引用时您会忘记更新它,导致构建被跳过。

路径过滤器反过来仍然很好用:排除没有构建会读取的文件,比如 docs/*,可以阻止整个流水线启动,而 dotnet-affected 负责决定其他所有事情。

接下来,考虑包更新、*.props 文件的变更,或者嵌入资源或其他共享文件的修改。这个问题比您想象的要复杂,一个 90% 正确的解决方案会导致构建被跳过或不必要的运行,这就违背了优化流水线的初衷。

幸运的是,我们是 .NET 开发者!您的解决方案已经知道哪个项目依赖于哪个项目:那就是 MSBuild 项目图。而这正是 dotnet-affected 用来根据仓库中的变更确定需要构建哪些项目的方法。

您给 dotnet-affected 两个提交。它查看它们之间变更的文件,找到这些文件所属的项目,然后遍历项目图,找到直接或间接依赖于这些项目的每一个项目。变更的 .csproj 文件和 NuGet 包版本也会被考虑在内。我在我的仓库上针对几个月的变更运行了它,每次都能正确识别受影响的_projects。

dotnet-affected 如何从 git diff 得到受影响项目列表(简化版)。基于 dotnet-affected 文档

将其安装为本地工具,这样版本就会固定在您的仓库中: dotnet new tool-manifest # 如果您还没有 dotnet tool install dotnet-affected

然后: dotnet affected --from 4f2a91c --uncommitted none --format text

这将 4f2a91c 与 HEAD 进行比较,并将每个受影响项目的完整路径写入 affected.txt。当没有受到影响时,它以代码 166 退出,而不是 0。--uncommitted none 跳过对未提交变更的检查,CI agent 没有这些变更。

目标是避免不必要的构建,同时不跳过任何实际需要的构建。dotnet-affected 在这方面有帮助,但它不是全貌。我们总是希望在以下情况下运行流水线:

您可以将 main/master 或 Git flow 的 release 或 hotfix 分支添加到此列表中,以便它们始终触发构建,但目前我更倾向于依赖下面的检测逻辑。

每个应用流水线都会获得一个新的第一阶段,用于决定该应用是否需要构建。构建和部署阶段仅在流水线确定应用受到影响时运行。

Orders API 的流水线

stages:

  • stage: CheckAffected jobs:
  • job: Check pool:

我们正在运行 bash 脚本,因此需要一个可以使用 bash 的 Linux 环境

(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)

正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。

打开原文
去社区讨论 →