如何在Jenkins共享库中实现Git多仓库稀疏检出？

完全可行，Jenkins的GitSCM插件支持多仓库配置结合稀疏检出（Sparse Checkout），刚好能实现你要的多Git仓库+指定目录共享库需求。

你的现有代码存在的问题 #

你当前的代码有几个关键问题导致无法灵活调用特定仓库和目录：

• 定义了files参数但未实际使用，硬编码了稀疏检出路径，无法动态传入指定目录
• 多仓库共用同一个${GIT_BRANCH}环境变量，若不同仓库分支名不一致会出错
• 未明确多仓库的检出隔离方式，容易出现文件覆盖

修正后的共享库方法 #

下面是调整后的代码，支持动态传入多仓库的配置（仓库地址、分支、指定目录、检出目标路径）：

def call(scmConfigs) {
    // 遍历每个仓库的配置，生成对应的GitSCM检出配置
    def gitScmList = scmConfigs.collect { config ->
        [
            $class: 'GitSCM',
            // 支持自定义分支，默认使用流水线的GIT_BRANCH环境变量
            branches: [[name: config.branch ?: '${GIT_BRANCH}']],
            extensions: [
                // 动态生成稀疏检出路径
                [$class: 'SparseCheckoutPaths', sparseCheckoutPaths: config.sparsePaths.collect { [path: it] }],
                // 强制指定检出目录，避免多仓库文件冲突
                [$class: 'RelativeTargetDirectory', relativeTargetDir: config.targetDir ?: config.repoName]
            ],
            userRemoteConfigs: [[url: config.repoUrl]]
        ]
    }

    // 逐个执行每个仓库的检出操作
    gitScmList.each { scm ->
        checkout(scm)
    }
}

流水线中的调用方式 #

假设你的共享库已经在Jenkins中配置完成，在Jenkinsfile里可以这样调用，精准指定每个仓库的信息：

// 加载共享库
@Library('your-shared-library-name') _

pipeline {
    agent any
    stages {
        stage('检出多仓库指定目录') {
            steps {
                script {
                    checkoutMultiRepos([
                        // 仓库1：只检出foo、bar、mike目录
                        [
                            repoName: 'repo1',
                            repoUrl: 'git@example.com:team/repo1.git',
                            branch: 'main',
                            sparsePaths: ['foo/', 'bar/', 'mike/'],
                            targetDir: 'repo1'
                        ],
                        // 仓库2：检出整个仓库
                        [
                            repoName: 'repo2',
                            repoUrl: 'git@example.com:team/repo2.git',
                            branch: 'develop',
                            sparsePaths: [''],
                            targetDir: 'repo2'
                        ],
                        // 仓库3：只检出docs和scripts目录
                        [
                            repoName: 'repo3',
                            repoUrl: 'git@example.com:team/repo3.git',
                            sparsePaths: ['docs/', 'scripts/'],
                            targetDir: 'repo3'
                        ]
                    ])
                }
            }
        }
    }
}

注意事项 #

• 确保Jenkins安装了Git插件（稀疏检出功能已包含在Git插件中，无需额外安装单独的稀疏检出插件）
• 私有仓库需要在Jenkins中配置对应的凭证（SSH密钥或用户名密码），并在调用时指定（若未全局配置）
• 必须指定RelativeTargetDirectory，否则多个仓库的文件会被检出到同一个根目录，导致文件覆盖

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