如何在Jenkins中获取Git当前分支并传递给Sonar Scanner?
解决Jenkins分离HEAD状态下获取分支名传递给SonarQube的问题
方法1:直接使用GitLab触发事件提供的环境变量
当Jenkins任务由GitLab推送事件触发时,GitLab插件会自动注入环境变量,直接引用即可拿到分支名,无需执行Git命令:
- 直接使用
${GITLAB_BRANCH}环境变量,传递给Sonar Scanner的sonar.branch.name参数,示例命令:sonar-scanner -Dsonar.projectKey=your-project-key -Dsonar.branch.name=${GITLAB_BRANCH}
如果该变量未生效,可尝试${CI_COMMIT_BRANCH}(GitLab原生变量,Jenkins的GitLab插件通常会同步)。
方法2:通过Git命令从远程追踪关系提取分支名
若环境变量不可用,可通过Git命令从当前提交的远程追踪分支中解析分支名:
- 获取远程追踪分支的完整名称(如
origin/feature/test):REMOTE_BRANCH=$(git rev-parse --symbolic-full-name --abbrev-ref @{u}) - 去掉
origin/前缀得到实际分支名:CURRENT_BRANCH=${REMOTE_BRANCH#origin/} - 将
${CURRENT_BRANCH}传入Sonar Scanner:sonar-scanner -Dsonar.projectKey=your-project-key -Dsonar.branch.name=${CURRENT_BRANCH}
也可以用一行命令直接输出结果:
git for-each-ref --format='%(refname:short)' $(git symbolic-ref -q HEAD) | sed 's/^origin\///'
方法3:修改Jenkins配置避免分离HEAD状态
调整Jenkins的Git仓库配置,让克隆后自动切换到对应分支,从根源解决分离HEAD问题:
- 在Jenkins任务的「源码管理」→「Git」配置中,点击「Additional Behaviours」→「Add」,选择「Checkout to specific local branch」
- 在「Branch name」输入框中填写
${GITLAB_BRANCH}(或对应环境变量),这样Jenkins会在克隆后自动切换到触发事件的分支 - 之后即可正常使用
git branch --show-current或git rev-parse --abbrev-ref HEAD获取分支名
内容的提问来源于stack exchange,提问作者Nicolas Baumann
相关产品推荐
相关产品推荐

