如何用Groovy编写Jenkins Pipeline校验远程从机是否存在对应Git分支及版本

核心逻辑是通过比对远程目标分支最新Commit哈希与从机本地仓库的当前Commit哈希，判断是否需要执行拉取操作，避免重复拉取消耗资源。 #

完整Pipeline示例 #

pipeline {
    agent any
    parameters {
        string(name: 'GIT_REPO_URL', defaultValue: 'https://your-git-repo-address.git', description: 'Git仓库地址')
        string(name: 'TARGET_BRANCH', defaultValue: 'main', description: '需要部署的目标分支')
        string(name: 'LOCAL_REPO_DIR', defaultValue: '/opt/workspace/your-project', description: '从机上的代码存储目录')
    }
    stages {
        stage('校验本地代码版本') {
            steps {
                script {
                    // 初始化跳过拉取标记，默认不跳过
                    skipCheckout = false
                    // 第一步：判断本地仓库目录是否存在，且包含.git文件
                    def repoDirExists = fileExists("${LOCAL_REPO_DIR}/.git")
                    if (repoDirExists) {
                        dir("${LOCAL_REPO_DIR}") {
                            // 获取本地当前Commit哈希
                            def localCommit = sh(script: 'git rev-parse HEAD', returnStdout: true).trim()
                            // 获取远程目标分支的最新Commit哈希
                            def remoteCommitRaw = sh(script: "git ls-remote ${GIT_REPO_URL} ${TARGET_BRANCH}", returnStdout: true).trim()
                            def remoteCommit = remoteCommitRaw.split()[0]
                            // 比对哈希
                            if (localCommit == remoteCommit) {
                                println "本地代码版本与远程目标分支一致，跳过拉取步骤"
                                skipCheckout = true
                            } else {
                                println "本地代码版本与远程不一致，需要执行拉取"
                            }
                        }
                    } else {
                        println "本地无对应仓库目录，需要执行拉取"
                    }
                }
            }
        }
        stage('拉取代码') {
            when {
                expression { return !skipCheckout }
            }
            steps {
                // 清理旧目录（如果存在）后拉取最新代码
                sh "rm -rf ${LOCAL_REPO_DIR} && mkdir -p ${LOCAL_REPO_DIR}"
                dir("${LOCAL_REPO_DIR}") {
                    git branch: "${TARGET_BRANCH}", url: "${GIT_REPO_URL}"
                }
            }
        }
        stage('代码构建') {
            steps {
                dir("${LOCAL_REPO_DIR}") {
                    // 替换为实际构建命令，比如maven、npm构建逻辑
                    sh 'echo 执行代码构建逻辑'
                }
            }
        }
        stage('安装客户端') {
            steps {
                dir("${LOCAL_REPO_DIR}") {
                    // 替换为实际安装部署命令
                    sh 'echo 执行客户端安装逻辑'
                }
            }
        }
    }
}

适配场景说明 #

• 全新机器场景：本地无对应仓库目录，skipCheckout标记为false，自动执行代码拉取、构建、安装全流程
• 复用从机场景：如果本地哈希和远程哈希一致，自动跳过拉取阶段，直接执行后续构建、安装步骤

可选优化项 #

如果需要处理本地存在未提交变更的情况，可以在校验阶段增加本地仓库状态检查，避免本地修改导致哈希比对失效：

// 放在获取localCommit之后执行即可
def localStatus = sh(script: 'git status --porcelain', returnStdout: true).trim()
if (localStatus) {
    println "本地存在未提交的变更，强制执行拉取"
    skipCheckout = false
}

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