Jenkins脚本化流水线：如何动态生成scmGit的扩展与远程配置？

我通过Jenkins流水线代码生成器生成了一段用于克隆派生仓库并合并多分支的代码：

checkout scmGit(branches: [[name: 'forkA/branchA']],
extensions: [cleanBeforeCheckout(),
            [$class: 'PreBuildMerge',
                options: [fastForwardMode: 'NO_FF',
                mergeRemote: 'forkA',
                mergeTarget: 'branchB']],
            [$class: 'PreBuildMerge',
                options: [fastForwardMode: 'NO_FF',
                mergeRemote: 'forkB',
                mergeTarget: 'branchC']],
            [$class: 'PreBuildMerge',
                options: [fastForwardMode: 'NO_FF',
                mergeRemote: 'forkA',
                mergeTarget: 'branchA']],
            localBranch('branchA')],
userRemoteConfigs: [[name: 'forkA',
url: 'git@gitlab.blah.com:forkA/ProjectA'],
[name: 'forkB',
refspec: '+refs/heads/branchC:refs/remotes/forkB/branchC',
url: 'git@gitlab.gitlab.com:forkB/ProjectA']])

我希望在脚本化流水线中，基于派生仓库与分支的映射列表动态生成scmGit的extensions和userRemoteConfigs部分。尝试用Map数组实现时抛出以下异常：

java.lang.ClassCastException: hudson.plugins.git.GitSCM.extensions expects class hudson.plugins.git.extensions.GitSCMExtension but received class java.util.ArrayList at org.jenkinsci.plugins.structs.describable.DescribableModel.coerce(DescribableModel.java:492)

目前我通过全局共享流水线导入大量Git相关类实现了动态生成，但耦合度太高，希望改用代码生成器那样的Map语法来构建，避免直接依赖具体实现类。

解决方案：用Map语法动态构建scmGit参数 #

1. 动态生成extensions列表 #

直接用Jenkins支持的结构化Map语法（和代码生成器输出一致），不需要导入任何类：

• 对于有内置工厂方法的扩展（比如cleanBeforeCheckout、localBranch），直接调用方法即可
• 对于无内置方法的扩展（比如PreBuildMerge），用$class指定类名，配合参数Map定义配置

def buildExtensions(String targetBranch, String mainRepo, Map repoBranchMap) {
    def extensions = []
    // 添加代码生成器里的cleanBeforeCheckout
    extensions.add(cleanBeforeCheckout())
    
    // 遍历派生仓库-分支映射，生成PreBuildMerge配置
    repoBranchMap.each { repo, branches ->
        branches.each { branch ->
            extensions.add([
                $class: 'PreBuildMerge',
                options: [
                    fastForwardMode: 'NO_FF',
                    mergeRemote: repo,
                    mergeTarget: branch
                ]
            ])
        }
    }
    
    // 添加主仓库分支的PreBuildMerge
    extensions.add([
        $class: 'PreBuildMerge',
        options: [
            fastForwardMode: 'NO_FF',
            mergeRemote: mainRepo,
            mergeTarget: targetBranch
        ]
    ])
    
    // 添加localBranch配置
    extensions.add(localBranch(targetBranch))
    
    return extensions
}

2. 动态生成userRemoteConfigs列表 #

同样用Map结构构建，无需导入UserRemoteConfig类，直接按代码生成器的格式拼接参数：

def buildUserRemoteConfigs(String gitRoot, String projectName, String mainRepo, Map repoBranchMap) {
    def configs = []
    // 主仓库配置
    configs.add([
        name: mainRepo,
        url: "${gitRoot}${mainRepo}/${projectName}",
        refspec: "refs/heads/*:refs/remotes/${mainRepo}/*"
    ])
    
    // 派生仓库配置：拼接对应分支的refspec
    repoBranchMap.each { repo, branches ->
        def refspec = branches.collect { branch ->
            "+refs/heads/${branch}:refs/remotes/${repo}/${branch}"
        }.join(' ')
        
        configs.add([
            name: repo,
            url: "${gitRoot}${repo}/${projectName}",
            refspec: refspec
        ])
    }
    
    return configs
}

3. 封装调用方法 #

把上述两个方法整合到共享库方法中，调用方式和之前完全一致：

def gitSCM(String projectName, String branch, String repoName, Map repoBranchMap = [:], String directory = env.WORKSPACE) {
    dir(directory) {
        checkout scmGit(
            branches: [[name: "${repoName}/${branch}"]],
            extensions: buildExtensions(branch, repoName, repoBranchMap),
            userRemoteConfigs: buildUserRemoteConfigs(GIT_SSH_URL(), projectName, repoName, repoBranchMap)
        )
    }
}

异常原因说明 #

你遇到的ClassCastException通常是因为：

• 构建的Map结构不符合Jenkins结构化API要求，比如缺少$class字段（对于无内置工厂方法的扩展类）
• 错误地传递了未正确格式化的List，但实际上Jenkins的结构化API可以自动将符合格式的Map转换为对应实例，只要结构和代码生成器输出一致即可。

调用示例 #

在脚本化流水线中调用方式不变：

common.gitSCM('ProjectA', 'branchA', 'forkA', [forkA: ['branchB'], forkB: ['branchC'] ])

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