Incrementalist 项目教程

1. 项目目录结构及介绍

Incrementalist 是一个.NET工具，旨在通过使用 libgit2sharp 和 Roslyn 来计算大型.NET解决方案的增量构建步骤。以下是其目录结构的基本介绍：

.
├── .github
├── build-system
├── docs
├── scripts
├── src
│   └── Incrementalist.sln
├── .gitignore
├── Incrementalist.sln.DotSettings
├── LICENSE
├── NuGet.config
├── README.md
├── RELEASE_NOTES.md
├── build.ps1
├── global.json
└── incrementalist.sample.json

• .github：包含与GitHub Actions相关的配置文件。
• build-system：构建系统相关的文件。
• docs：项目文档。
• scripts：项目脚本。
• src：源代码目录，包含解决方案文件（Incrementalist.sln）。
• .gitignore：指定Git应忽略的文件和目录。
• Incrementalist.sln.DotSettings：解决方案的DotSettings文件，可能包含IDE配置。
• LICENSE：项目许可证信息。
• NuGet.config：NuGet配置文件。
• README.md：项目自述文件。
• RELEASE_NOTES.md：版本发布说明。
• build.ps1：构建脚本的PowerShell脚本。
• global.json：全局配置文件，可能包含项目设置。
• incrementalist.sample.json：Incrementalist的示例配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过命令行工具 Incrementalist.Cmd 来进行的。安装此工具后，可以直接在命令行中使用 incrementalist 命令来运行相关的构建和测试操作。

以下是几个常用的启动命令：

# 获取受影响的项目列表
incrementalist run --dry -b dev -f ./affected-projects.txt

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

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

3. 项目的配置文件介绍

Incrementalist 使用JSON格式的配置文件来存储常用的设置。这可以避免在命令行中重复指定相同的参数。配置文件可以放在项目的 .incrementalist 目录下。

以下是一个配置文件的示例内容：

{
  "gitBranch": "dev",
  "verbose": true,
  "runInParallel": true
}

在运行命令时，可以通过 -c 参数指定配置文件的路径，如：

# 使用默认配置文件
incrementalist run -- build

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

配置文件中的设置可以被命令行参数覆盖。