如何在Jenkins Active Choices响应式参数Groovy脚本中克隆Git仓库

要在Active Choices的Groovy脚本里完成Git克隆并处理仓库内容，核心是利用Jenkins凭据API安全获取权限信息，结合系统命令执行Git操作，同时处理临时目录避免冲突。以下是具体实现：

1. 安全获取Git凭据 #

首先通过Jenkins内置的凭据服务，根据你预先配置的凭据ID取出用户名密码（或SSH密钥），避免硬编码敏感信息：

import jenkins.model.Jenkins
import com.cloudbees.plugins.credentials.CredentialsProvider
import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials

// 替换成你在Jenkins里配置的凭据ID
def credId = "git-repo-cred"
def jenkins = Jenkins.get()
def creds = CredentialsProvider.lookupCredentials(
    StandardUsernamePasswordCredentials.class,
    jenkins,
    null,
    null
).find { it.id == credId }

if (!creds) {
    return ["错误：找不到指定凭据，请检查凭据ID"]
}

def username = creds.username
def password = creds.password.plainText

2. 创建独立临时目录 #

为了避免多个任务或参数请求互相干扰，每次克隆都生成唯一的临时目录：

def tempDir = new File(System.getProperty("java.io.tmpdir"), "git-clone-${UUID.randomUUID()}")
tempDir.mkdirs()

3. 执行Git克隆命令 #

以HTTPS仓库为例，拼接带凭据的Git URL执行克隆；如果是SSH仓库，看后面的补充说明：

// 替换成你的Git仓库HTTPS地址
def repoUrl = "https://github.com/your-org/your-repo.git"
// 拼接包含凭据的URL，避免手动输入用户名密码
def authRepoUrl = repoUrl.replace("https://", "https://${username}:${password}@")

// 执行克隆命令并等待完成
def cloneProc = ["git", "clone", authRepoUrl, tempDir.absolutePath].execute()
cloneProc.waitFor()

// 检查克隆是否成功
if (cloneProc.exitValue() != 0) {
    def errMsg = "克隆失败：${cloneProc.err.text}"
    tempDir.deleteDir() // 清理临时目录
    return [errMsg]
}

4. 处理仓库内的目标内容 #

克隆完成后，就可以读取或处理仓库里的内容了。比如读取某个配置文件并提取参数选项：

def targetFile = new File(tempDir, "config/options.txt")
if (targetFile.exists()) {
    // 按行读取并过滤空行，作为参数选项返回
    def options = targetFile.readLines().findAll { it.trim() != "" }
    tempDir.deleteDir() // 清理临时目录
    return options
} else {
    tempDir.deleteDir()
    return ["错误：目标文件不存在"]
}

补充：SSH仓库的处理方式 #

如果你的Git仓库用SSH协议，需要改用SSH密钥凭据，并配置Git的SSH命令指向临时生成的私钥文件：

import com.cloudbees.plugins.credentials.common.StandardSSHUserPrivateKeyCredentials

def sshCred = CredentialsProvider.lookupCredentials(
    StandardSSHUserPrivateKeyCredentials.class,
    jenkins,
    null,
    null
).find { it.id == credId }

// 生成临时私钥文件
def privateKeyFile = new File(tempDir, "id_rsa")
privateKeyFile.text = sshCred.privateKey
privateKeyFile.setReadable(true, false) // 设置仅当前用户可读

// 配置Git使用临时私钥，关闭主机密钥检查避免交互
def env = System.getenv() + ["GIT_SSH_COMMAND": "ssh -i ${privateKeyFile.absolutePath} -o StrictHostKeyChecking=no"]
def cloneProc = ["git", "clone", "git@github.com:your-org/your-repo.git", tempDir.absolutePath].execute(env)
cloneProc.waitFor()

关键注意事项 #

• 确保Jenkins执行环境（Master或Agent）已安装Git命令行工具
• 脚本执行完毕务必清理临时目录，防止磁盘空间被占用
• 大仓库建议用浅克隆优化速度：git clone --depth 1 --branch your-target-branch，避免克隆全量历史导致超时
• 如果参数加载超时，可在Jenkins全局配置中调整Active Choices的超时时间

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