Incrementalist 项目使用教程

1. 项目介绍

Incrementalist 是一个针对 .NET 的工具，它利用 libgit2sharp 和 Roslyn 来计算大型解决方案的增量构建步骤。它可以优化您的 CI/CD 管道，通过只构建和测试受您更改影响的项目。

2. 项目快速启动

以下是如何安装和使用 Incrementalist 的基本步骤：

首先，确保您的系统已经安装了 .NET 8.0 SDK 或更高版本，并且 Git 已经安装并在系统路径中可用。

安装 Incrementalist

Incrementalist 可以以两种形式提供：作为 .NET 8 库用于编程使用，或者作为命令行工具（推荐）。

全局安装命令行工具：

dotnet tool install --global Incrementalist.Cmd

或者在您的项目中本地安装：

# 从您的仓库根目录
dotnet new tool-manifest
# 如果您还没有创建 .config/dotnet-tools.json 文件
dotnet tool install Incrementalist.Cmd

运行 Incrementalist

• 作为全局工具运行：

# 获取受影响的项目列表并保存到文件
incrementalist run --dry -b dev -f ./affected-projects.txt

# 列出受影响的文件夹
incrementalist list-affected-folders -b dev -f ./affected-folders.txt

# 对受影响的项目运行测试
incrementalist run -b dev --test -c Release

# 并行运行
incrementalist run -b dev --parallel -- build -c Release

• 作为本地工具运行：

# 获取受影响的项目列表并保存到文件
dotnet incrementalist -- -b dev -f ./affected-projects.txt

# 构建受影响的项目
dotnet incrementalist -- run -b dev -- build -c Release --nologo

# 运行受影响项目的测试
dotnet incrementalist -- run -b dev --test -c Release --no-build --nologo

配置文件

Incrementalist 支持使用 JSON 配置文件来存储常用的设置。这可以避免在命令行中重复指定相同的参数。

# 使用默认配置文件 (.incrementalist/incrementalist.json)
incrementalist run -- build

# 指定自定义配置文件
incrementalist -c my-config.json run -- build

# 创建配置文件
incrementalist create-config -b dev --verbose --parallel

3. 应用案例和最佳实践

大型解决方案

如果您的解决方案包含数十或数百个项目，Incrementalist 可以通过只构建必要的内容来显著减少构建时间。

Monorepos

在单一仓库中管理多个应用程序或服务时，Incrementalist 帮助识别并只构建受影响的组件。

微服务架构

在包含多个微服务的仓库中，只构建和测试受您更改影响的服务。

复杂依赖关系

当项目之间存在复杂的依赖关系时，Incrementalist 自动确定受影响的构建图。

CI/CD 优化

通过跳过不必要的构建和测试，减少 CI/CD 管道的执行时间。

4. 典型生态项目

Incrementalist 适用于各种 .NET 项目，包括但不限于：

• 大型企业级解决方案
• 单一仓库多服务架构
• 微服务架构
• 需要频繁构建和测试的 CI/CD 管道

通过使用 Incrementalist，开发者可以更加高效地管理和构建他们的项目，从而节省时间和资源。