Jenkins Pipeline：如何更新其他Git仓库文件并推送构建号变更？

准备工作 #

• 在Jenkins凭据管理中存储目标Git仓库的访问凭据：
  • 若用HTTPS：存储用户名+密码，记录凭据ID（比如git-external-creds）
  • 若用SSH：存储私钥，记录凭据ID（比如git-external-ssh）
• 确保执行Pipeline的Jenkins节点已安装Git客户端

完整Pipeline脚本示例 #

场景1：HTTPS方式访问Git仓库 #

pipeline {
    agent any
    stages {
        stage('Update External Git Repo') {
            steps {
                script {
                    // 加载Git凭据
                    withCredentials([usernamePassword(
                        credentialsId: 'git-external-creds',
                        usernameVariable: 'GIT_USER',
                        passwordVariable: 'GIT_PASS'
                    )]) {
                        sh """
                            # 克隆目标仓库（替换为你的仓库地址和分支）
                            git clone https://${GIT_USER}:${GIT_PASS}@github.com/your-org/target-repo.git
                            cd target-repo
                            # 写入构建号到指定文件（替换为你的文件路径）
                            echo ${BUILD_NUMBER} > build-version.txt
                            # 临时配置Git提交用户（避免Jenkins系统用户无配置）
                            git config user.name 'Jenkins Auto Bot'
                            git config user.email 'jenkins@your-company.com'
                            # 提交并推送变更
                            git add build-version.txt
                            git commit -m "Auto update build number to ${BUILD_NUMBER}"
                            git push origin main
                        """
                    }
                }
            }
        }
    }
    post {
        always {
            // 清理临时克隆的仓库
            sh 'rm -rf target-repo'
        }
    }
}

场景2：SSH方式访问Git仓库 #

pipeline {
    agent any
    stages {
        stage('Update External Git Repo') {
            steps {
                script {
                    withCredentials([sshUserPrivateKey(
                        credentialsId: 'git-external-ssh',
                        keyFileVariable: 'SSH_KEY'
                    )]) {
                        sh """
                            # 配置Git使用指定SSH密钥，关闭主机密钥检查避免交互
                            git config --global core.sshCommand "ssh -i ${SSH_KEY} -o StrictHostKeyChecking=no"
                            # 克隆目标仓库（替换为你的SSH仓库地址和分支）
                            git clone git@github.com:your-org/target-repo.git
                            cd target-repo
                            echo ${BUILD_NUMBER} > build-version.txt
                            git config user.name 'Jenkins Auto Bot'
                            git config user.email 'jenkins@your-company.com'
                            git add build-version.txt
                            git commit -m "Auto update build number to ${BUILD_NUMBER}"
                            git push origin main
                        """
                    }
                }
            }
        }
    }
    post {
        always {
            sh 'rm -rf target-repo'
            // 清理全局Git SSH配置，避免影响后续任务
            sh 'git config --global --unset core.sshCommand'
        }
    }
}

关键优化要点 #

• 凭据安全：绝对不要在脚本中硬编码账号密码，必须通过Jenkins凭据管理获取，避免泄露风险
• 临时Git配置：Jenkins运行的系统用户通常没有配置Git提交者信息，必须在脚本中临时设置user.name和user.email，否则提交会失败
• 冲突处理：如果目标仓库可能有其他人修改，建议在提交前先拉取最新代码（添加git pull origin main命令），避免推送失败；若是单写入源，可跳过但需做好失败重试
• 清理工作：在post阶段清理临时克隆的仓库，避免占用节点磁盘空间
• 分支指定：确保克隆和推送的是正确的分支（示例中用main，根据实际替换）
• 失败重试：可以给git push命令添加retry块，应对网络波动导致的推送失败：

  retry(3) {
      sh 'git push origin main'
  }
  

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