Jenkins中如何在CMake FetchContent阶段传递Git凭证？

问题概述 #

使用Jenkins构建CMake项目时，主项目通过Git插件可正常克隆，但CMake的FetchContent拉取私有依赖库时无法自动获取凭证，报错无法读取用户名/密码；尝试用withCredentials([gitUsernamePassword(...)]时，出现凭证助手脚本找不到的错误，导致密码无法传递。

可行解决方案 #

方案1：将凭证嵌入Git URL（推荐） #

通过Jenkins传递用户名密码环境变量，在CMake配置时把凭证注入到FetchContent的仓库URL中。

Jenkins Stage配置：

stage('Project Configure') {
    steps {
        withCredentials([usernamePassword(
            credentialsId: '<你的凭证ID>',
            usernameVariable: 'GIT_USER',
            passwordVariable: 'GIT_PASS'
        )]) {
            // 对密码进行URL编码，处理特殊字符
            def encodedPass = URLEncoder.encode(GIT_PASS, 'UTF-8')
            sh "cmake --preset=MyPreset -DFETCHCONTENT_CREDENTIALS_URL=https://${GIT_USER}:${encodedPass}@<你的私有Git服务器地址>"
        }
    }
}

CMakeLists.txt适配：

针对每个FetchContent声明的依赖，使用传入的URL前缀拼接仓库路径：

FetchContent_Declare(
    my_module
    GIT_REPOSITORY "${FETCHCONTENT_CREDENTIALS_URL}/path/to/my_module.git"
    GIT_TAG <目标分支/标签>
)

方案2：临时配置Git凭证助手 #

通过Git的credential.helper临时设置凭证输出脚本，让Git自动在需要时提供用户名和密码，无需交互。

Jenkins Stage配置：

stage('Project Configure') {
    steps {
        withCredentials([usernamePassword(
            credentialsId: '<你的凭证ID>',
            usernameVariable: 'GIT_USER',
            passwordVariable: 'GIT_PASS'
        )]) {
            sh '''
                # 临时设置Git凭证助手，输出预设的用户名密码
                git config --global credential.helper '!f() { echo "username=$GIT_USER"; echo "password=$GIT_PASS"; }; f'
                # 执行CMake配置
                cmake --preset=MyPreset
                # 清理全局配置，避免影响后续步骤
                git config --global --unset credential.helper
            '''
        }
    }
}

原方案失败原因 #

你之前使用的gitUsernamePassword会自动设置GIT_ASKPASS环境变量，指向Jenkins生成的临时脚本，但该脚本在部分环境（如容器构建、PATH配置异常）中可能无法被Git正常调用，导致出现?: not found和凭证读取失败的错误。上述两种方法绕过了这个自动生成的助手脚本，直接通过URL注入或手动配置凭证的方式确保Git能获取到正确的认证信息。

注意事项 #

• 如果密码包含特殊字符（如@、&、%等），必须进行URL编码，否则会破坏URL结构导致认证失败；
• 方案2中使用git config --global会修改全局Git配置，因此必须在CMake执行完成后清理该配置，避免影响后续构建步骤；
• 确保Jenkins节点的Git版本支持credential.helper功能（Git 1.7.10及以上版本均支持）。

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