TeamCity中Jenkins‘Build with Parameters’等效功能及分支参数传递问题

问题描述 #

我正在将Jenkins CI作业迁移至TeamCity，找不到Jenkins中“Build with Parameters”的等效功能。我的管道构建如下：

1. 存在一个名为ScriptBuildType(script: String)的BuildType，用于运行指定脚本，并关联带有配置参数%my.vcs.branch%的VCS以指定分支。
2. 子项目MySubProject运行一系列ScriptBuildType构建链：

sequential {
    ScriptBuildType("script 1...")
    ScriptBuildType("script 2...")
    parallel {
        ScriptBuildType("script 3...")
        ScriptBuildType("script 4...")
    }
    ScriptBuildType("script 5")
}.buildTypes()

当在TeamCity UI中为最后一个ScriptBuildType指定%my.vcs.branch%值运行时，该构建使用指定值，但构建链中其余依赖项均使用默认值。如何让整个构建链使用我定义的%my.vcs.branch%值？

解决方案 #

1. 将分支参数提升至项目级别

不要在单个ScriptBuildType中定义my.vcs.branch参数，而是在MySubProject的项目参数中添加该参数：

• 进入TeamCity UI的MySubProject设置页面
• 找到「参数」选项，添加参数my.vcs.branch，设置合适的默认分支值
• 确保所有ScriptBuildType的VCS分支配置直接引用%my.vcs.branch%，不再单独定义该参数

这样所有属于MySubProject的ScriptBuildType都会继承这个参数，避免参数重复定义导致的传递问题。

2. 创建顶层复合构建配置（推荐）

TeamCity的复合构建配置可以将整个构建链打包成一个可触发的整体，参数会自动传递给所有子构建：
修改你的DSL代码，创建一个包含完整构建链的复合构建：

val fullBuildChain = CompositeBuildType {
    name = "Full Build Chain"
    // 暴露分支参数，允许在触发时修改
    parameters {
        param("my.vcs.branch", "main") // 设置默认分支
    }
    // 定义构建链顺序
    buildTypesOrder = sequential {
        ScriptBuildType("script 1...")
        ScriptBuildType("script 2...")
        parallel {
            ScriptBuildType("script 3...")
            ScriptBuildType("script 4...")
        }
        ScriptBuildType("script 5")
    }
}

之后你只需要触发这个Full Build Chain复合构建，在触发时输入my.vcs.branch的值，整个构建链的所有ScriptBuildType都会使用这个指定的分支值。

3. 替代方案：配置参数传递规则

如果不想使用复合构建，可以为每个ScriptBuildType配置参数传递规则，确保上游构建的分支参数传递给下游：

• 进入每个ScriptBuildType的设置页面
• 找到「触发规则」→「添加新触发」→「依赖构建触发」
• 在触发配置中，开启「传递参数」选项，指定将my.vcs.branch参数从依赖的构建传递过来

不过这种方式需要逐个配置，维护成本较高，不如复合构建简洁。

内容的提问来源于stack exchange，提问作者idanz