如何在Jenkins WorkflowJob中修改SCM配置？

核心原因 #

WorkflowJob（简单流水线）的SCM配置并非直接存储在SCMs字段中，该字段是只读的派生属性，实际配置保存在流水线的FlowDefinition中（如果是「Pipeline script from SCM」类型的流水线，对应CpsScmFlowDefinition类）。因此直接修改SCMs列表或其元素会失败，必须通过修改FlowDefinition或底层配置XML实现。

方案1：针对「Pipeline script from SCM」类型的流水线 #

这种场景下，WorkflowJob的SCM用于拉取Jenkinsfile，可通过替换CpsScmFlowDefinition实例来更新SCM：

import jenkins.model.Jenkins
import org.jenkinsci.plugins.workflow.job.WorkflowJob
import org.jenkinsci.plugins.workflow.cps.CpsScmFlowDefinition
import hudson.plugins.git.GitSCM

// 替换为你的Job名称
def targetJobName = "your-pipeline-job"
WorkflowJob job = Jenkins.get().getItem(targetJobName, WorkflowJob)

if (job) {
    def flowDefinition = job.getDefinition()
    if (flowDefinition instanceof CpsScmFlowDefinition) {
        // 获取原SCM配置
        GitSCM oldScm = flowDefinition.getScm() as GitSCM
        
        // 生成新的GitSCM实例（示例：修改远程URL和凭证）
        def newRemotes = oldScm.getUserRemoteConfigs().collect { remote ->
            new hudson.plugins.git.UserRemoteConfig(
                "https://new-git-repo-url.git",  // 新URL
                remote.getName(),
                remote.getRefspec(),
                "new-credential-id"              // 新凭证ID
            )
        }
        
        GitSCM newScm = new GitSCM(
            newRemotes,
            oldScm.getBranches(),
            oldScm.isDoGenerateSubmoduleConfigurations(),
            oldScm.getSubmoduleCfg(),
            oldScm.getBrowser(),
            oldScm.getGitTool(),
            oldScm.getExtensions()
        )
        
        // 创建新的FlowDefinition并替换
        def newFlowDefinition = new CpsScmFlowDefinition(newScm, flowDefinition.getScriptPath())
        job.setDefinition(newFlowDefinition)
        
        // 保存Job配置
        job.save()
        println "SCM配置更新完成"
    } else {
        println "该流水线不是基于SCM的定义（可能是脚本式流水线）"
    }
} else {
    println "未找到指定Job"
}

方案2：通用XML配置修改法（适配所有场景） #

如果方案1不适用，可通过configure闭包直接修改Job的底层配置XML，原理和UI修改配置一致：

import jenkins.model.Jenkins
import org.jenkinsci.plugins.workflow.job.WorkflowJob

def targetJobName = "your-pipeline-job"
WorkflowJob job = Jenkins.get().getItem(targetJobName, WorkflowJob)

if (job) {
    job.configure { xmlNode ->
        // 定位到SCM配置节点（针对GitSCM）
        def scmNode = xmlNode / definition / scm
        
        // 修改远程仓库URL
        scmNode / userRemoteConfigs / 'hudson.plugins.git.UserRemoteConfig' / url = "https://new-git-repo-url.git"
        
        // 修改凭证ID
        scmNode / userRemoteConfigs / 'hudson.plugins.git.UserRemoteConfig' / credentialsId = "new-credential-id"
        
        // 修改分支规则
        scmNode / branches / 'hudson.plugins.git.BranchSpec' / name = "*/main"
    }
    
    job.save()
    println "通过XML修改SCM配置完成"
} else {
    println "未找到指定Job"
}

关键注意事项 #

1. GitSCM不可变性：GitSCM的多数字段是不可变的，无法直接修改现有实例的属性（如userRemoteConfigs），必须创建新的GitSCM实例替换。
2. 配置保存：修改完成后必须调用job.save()，否则修改不会持久化到Jenkins配置文件中。
3. 权限要求：执行代码的账号需要拥有Job的「配置」权限。

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