Git学习-->关于Jenkins编译时候，如何获取Git分支的当前分支名？

时间  2019-11-20
标签 git 学习 关于 jenkins 编译 时候 如何 获取 分支 当前 栏目 Git 繁體版
原文   原文链接

1、背景

由于代码都迁移到了Gitlab，因此Jenkins编译的时候咱们都须要将以前的SVN信息换成如今的Git信息。最近编译一个Lib库的时候，由于团队规定上传Release版本的AAR到Maven的话，必须须要在Jenkins上编译并且Git Branch 必须是master分支才可以上传到Maven。
所以咱们就须要在Gradle脚本中，获取Git Branch ,Git Commit等相关信息。可是在获取Git Branch的时候出现了问题，在本地Android Studio编译的时候可以获取到Git Branch的名字，可是使用Jenkins编译的时候，一直获取不到信息。css

下面是我写的一份gradle文件，用于获取Git和Jenkins的相关信息java

/** * 获取Git 分支名 */
def getGitBranch() {
    return 'git symbolic-ref --short -q HEAD'.execute().text.trim()
}

/** * 获取Git 版本号 */
def getGitSHA() {
    return 'git rev-parse --short HEAD'.execute().text.trim()
}

/** * 获取Git Tag */
def getGitTag() {
    return 'git describe --tags'.execute([], project.rootDir).text.trim()
}

/** * 获取Git 提交次数 */
def getGitCommitCount() {
    return 100 + Interger.parse('git rev-list --count HEAD'.execute([], project.rootDir).text.trim())
}

/** * 判断是否有jenkins */
boolean isInJenkins() {
    Map<String, String> map = System.getenv()
    if (map == null) {
        return false
    }
    String str = map.get("Path")
    if (str != null) {
        //it's windows
        return false
    } else {
        str = ""
        Iterator it = map.iterator()
        while (it.hasNext()) {
            str += it.next()
        }
        return str.contains("jenkins")
    }
}
/** * 获取jenkins任务名 */
def getJenkinsName() {
    boolean flag = isInJenkins()
    if (flag) {
        ext.env = System.getenv()
        ext.name = env.JOB_URL
        String[] stringArray = ext.name.split("/")
        if (stringArray.length > 0) {
            return stringArray[stringArray.length - 1]
        } else {
            return "Local"
        }
    } else {
        return "Local"
    }
}

/** * 获取Jenkins Build 号 * @return */
def getJenkinsBuildCode() {
    boolean flag = isInJenkins()
    if (flag) {
        ext.env = System.getenv()
        ext.buildNumber = env.BUILD_NUMBER?.toInteger()
        return "$buildNumber"
    } else {
        return 0
    }
}

/** * 定义几个变量，在build.gradle里面引用 */
ext {
    gitTag = getGitTag()
    gitBranch = getGitBranch()
    gitSHA = getGitSHA()
    jenkinsRevision = getJenkinsBuildCode()
    jenkinsName = getJenkinsName()
}

其中的方法，getGitBranch方法在Android Studio编译的时候，可以正常获取到Git分支名。android

println "pom_version_type = " + pom_version_type
    println "jenkinsName = " + jenkinsName
    println "gitBranch = " + gitBranch

我在进行编译的时候，是会经过如上代码打印出Git Branch的信息。git

在Android Studio 本地编译的时候，是能够打印出相关的信息的。windows

这里写图片描述

可是在Jenkins编译的时候，是不可以上传的，以下所示：
这里写图片描述ruby

2、解决方法

后来我尝试找了不少种方法去获取Git Branch的名字，在Android Studio本地均可以获取到，以下所示：bash

参考连接：https://stackoverflow.com/questions/6245570/how-to-get-the-current-branch-name-in-git服务器

方法一、git symbolic-ref --short -q HEAD微信

D:\GitLab Source\XTCLint>git symbolic-ref --short -q HEAD
master

D:\GitLab Source\XTCLint>

这里写图片描述

方法二、git rev-parse --abbrev-ref HEADmarkdown

D:\GitLab Source\XTCLint>git rev-parse --abbrev-ref HEAD
master

这里写图片描述

方法三、git branch | grep \* | cut -d ' ' -f2

D:\GitLab Source\XTCLint>git branch | grep \* | cut -d ' ' -f2
master

这里写图片描述

方法四、git symbolic-ref HEAD | sed -e "s/^refs\/heads\///"

D:\GitLab Source\XTCLint>git symbolic-ref HEAD | sed -e "s/^refs\/heads\///"
master

这里写图片描述

以上全部的方法，仅仅在Android Studio的终端或者本地gradle代码中有效，然而在Jenkins服务器编译的时候都是获取为空。

后来我查看了Jenkins的Git插件上的介绍，参考连接：https://wiki.jenkins.io/display/JENKINS/Git+Plugin

这里写图片描述

如上所示，在上面的连接中有介绍，有几个Environment variables环境变量可使用。

Environment variables

The git plugin sets several environment variables you can use in your scripts:

  • GIT_COMMIT - SHA of the current
  • GIT_BRANCH - Name of the remote repository (defaults to origin), followed by name of the branch currently being used, e.g. “origin/master” or “origin/foo”
  • GIT_LOCAL_BRANCH - Name of the branch on Jenkins. When the “checkout to specific local branch” behavior is configured, the variable is published. If the behavior is configured as null or **, the property will contain the resulting local branch name sans the remote name.
  • GIT_PREVIOUS_COMMIT - SHA of the previous built commit from the same branch (the current SHA on first build in branch)
  • GIT_PREVIOUS_SUCCESSFUL_COMMIT - SHA of the previous successfully built commit from the same branch.
  • GIT_URL - Repository remote URL
  • GIT_URL_N - Repository remote URLs when there are more than 1 remotes, e.g. GIT_URL_1, GIT_URL_2
  • GIT_AUTHOR_NAME and GIT_COMMITTER_NAME - The name entered if the “Custom user name/e-mail address” behaviour is enabled; falls back to the value entered in the Jenkins system config under “Global Config user.name Value” (if any)
  • GIT_AUTHOR_EMAIL and GIT_COMMITTER_EMAIL - The email entered if the “Custom user name/e-mail address” behaviour is enabled; falls back to the value entered in the Jenkins system config under “Global Config user.email Value” (if any)

而后我将这几个变量，在一个app的Jenkins任务中，编译完成后的邮件内容中添加了这几个变量的内容，以下所示：

这里写图片描述

在构建后的操做中，Editable Email Notification的邮件通知中，将邮件内容改成以下所示的代码。

$DEFAULT_CONTENT

<br />
<font color="#0B610B">单元测试</font>
  <li>Launcher单元测试报告&nbsp;：<a href="${BUILD_URL}testReport">点击查看测试报告</a></li>
  <li>Launcher代码覆盖率&nbsp;：<a href="${BUILD_URL}jacoco">点击查看代码覆盖率</a></li>
  <li>Launcher Android Lint&nbsp;：<a href="${BUILD_URL}androidLintResult">点击查看Android Lint</a></li>


<br />
 <li>GIT_COMMIT&nbsp;：${GIT_COMMIT}</a></li>
 <li>GIT_BRANCH&nbsp;：${GIT_BRANCH}</a></li>
 <li>GIT_LOCAL_BRANCH&nbsp;：${GIT_LOCAL_BRANCH}</a></li>
 <li>GIT_PREVIOUS_COMMIT&nbsp;：${GIT_PREVIOUS_COMMIT}</a></li>
 <li>GIT_PREVIOUS_SUCCESSFUL_COMMIT&nbsp;：${GIT_PREVIOUS_SUCCESSFUL_COMMIT}</a></li>
 <li>GIT_URL&nbsp;：${GIT_URL}</a></li>
 <li>GIT_URL_N&nbsp;：${GIT_URL_N}</a></li>
 <li>GIT_AUTHOR_NAME&nbsp;：${GIT_AUTHOR_NAME}</a></li>
 <li>GIT_COMMITTER_NAME&nbsp;：${GIT_COMMITTER_NAME}</a></li>
 <li>GIT_AUTHOR_EMAIL&nbsp;：${GIT_AUTHOR_EMAIL}</a></li>
 <li> GIT_COMMITTER_EMAIL&nbsp;：${ GIT_COMMITTER_EMAIL}</a></li>

这样编译完后，收到的邮件内容以下：
这里写图片描述

如上所示，收到的邮件内容包含了Git的相关信息：

GIT_COMMIT ：118fa74e6a09c8c5ae713523692add256bfa6afb
GIT_BRANCH ：origin/feature/UseByAnonymousDBMigrateAndApiChange
GIT_LOCAL_BRANCH ：${GIT_LOCAL_BRANCH}
GIT_PREVIOUS_COMMIT ：118fa74e6a09c8c5ae713523692add256bfa6afb
GIT_PREVIOUS_SUCCESSFUL_COMMIT ：118fa74e6a09c8c5ae713523692add256bfa6afb
GIT_URL ：git@172.28.1.116:Android/WatchApp/Third/NetEaseCloudMusic.git
GIT_URL_N ：${GIT_URL_N}
GIT_AUTHOR_NAME ：${GIT_AUTHOR_NAME}
GIT_COMMITTER_NAME ：${GIT_COMMITTER_NAME}
GIT_AUTHOR_EMAIL ：${GIT_AUTHOR_EMAIL}
GIT_COMMITTER_EMAIL ：${ GIT_COMMITTER_EMAIL}

其中，GIT_BRANCH这个环境变量的值为origin/feature/UseByAnonymousDBMigrateAndApiChange，表明Jenkins上/UseByAnonymousDBMigrateAndApiChange分支远程Gitlab上该分支映射的远程分支。所以咱们能够对GIT_BRANCH这个环境变量作作文章。

将以前gradle脚本中的getGitBranch方法，作以下修改，区分编译环境是Jenkins仍是本地。环境不一样，运行不一样的脚本获取Git Branch的名字。当处于Jenkins环境的时候，先经过GIT_BRANCH这个环境变量获取到Jenkins拉下来的分支对应的远程分支，而后经过字符串分离，获取到分支名。

/**
 * 获取Git 分支名
 *
 *参考Jenkins git 建立文档： https://wiki.jenkins.io/display/JENKINS/Git+Plugin
 *   Environment variables

 The git plugin sets several environment variables you can use in your scripts:

 GIT_COMMIT - SHA of the current
 GIT_BRANCH - Name of the remote repository (defaults to origin), followed by name of the branch currently being used, e.g. "origin/master" or "origin/foo"
 GIT_LOCAL_BRANCH - Name of the branch on Jenkins. When the "checkout to specific local branch" behavior is configured, the variable is published.  If the behavior is configured as null or **, the property will contain the resulting local branch name sans the remote name.
 GIT_PREVIOUS_COMMIT - SHA of the previous built commit from the same branch (the current SHA on first build in branch)
 GIT_PREVIOUS_SUCCESSFUL_COMMIT - SHA of the previous successfully built commit from the same branch.
 GIT_URL - Repository remote URL
 GIT_URL_N - Repository remote URLs when there are more than 1 remotes, e.g. GIT_URL_1, GIT_URL_2
 GIT_AUTHOR_NAME and GIT_COMMITTER_NAME - The name entered if the "Custom user name/e-mail address" behaviour is enabled; falls back to the value entered in the Jenkins system config under "Global Config user.name Value" (if any)
 GIT_AUTHOR_EMAIL and GIT_COMMITTER_EMAIL - The email entered if the "Custom user name/e-mail address" behaviour is enabled; falls back to the value entered in the Jenkins system config under "Global Config user.email Value" (if any)
 *
 *
 */
def getGitBranch() {
    //判断是否处于Jenkins编译环境
    boolean flag = isInJenkins()
    if (flag) {
        ext.env = System.getenv()
        ext.gitBranch = env.GIT_BRANCH
        String[] stringArray = ext.gitBranch.split("/")
        if (stringArray.length > 0) {
            return stringArray[stringArray.length - 1]
        } else {
            return "UnKnown Branch"
        }
    } else {
        return 'git symbolic-ref --short -q HEAD'.execute().text.trim()
    }
}

完整代码以下所示：

/** * 获取Git 分支名 * *参考Jenkins git 建立文档： https://wiki.jenkins.io/display/JENKINS/Git+Plugin * Environment variables The git plugin sets several environment variables you can use in your scripts: GIT_COMMIT - SHA of the current GIT_BRANCH - Name of the remote repository (defaults to origin), followed by name of the branch currently being used, e.g. "origin/master" or "origin/foo" GIT_LOCAL_BRANCH - Name of the branch on Jenkins. When the "checkout to specific local branch" behavior is configured, the variable is published. If the behavior is configured as null or **, the property will contain the resulting local branch name sans the remote name. GIT_PREVIOUS_COMMIT - SHA of the previous built commit from the same branch (the current SHA on first build in branch) GIT_PREVIOUS_SUCCESSFUL_COMMIT - SHA of the previous successfully built commit from the same branch. GIT_URL - Repository remote URL GIT_URL_N - Repository remote URLs when there are more than 1 remotes, e.g. GIT_URL_1, GIT_URL_2 GIT_AUTHOR_NAME and GIT_COMMITTER_NAME - The name entered if the "Custom user name/e-mail address" behaviour is enabled; falls back to the value entered in the Jenkins system config under "Global Config user.name Value" (if any) GIT_AUTHOR_EMAIL and GIT_COMMITTER_EMAIL - The email entered if the "Custom user name/e-mail address" behaviour is enabled; falls back to the value entered in the Jenkins system config under "Global Config user.email Value" (if any) * * */ def getGitBranch() { //判断是否处于Jenkins编译环境 boolean flag = isInJenkins() if (flag) { ext.env = System.getenv() ext.gitBranch = env.GIT_BRANCH String[] stringArray = ext.gitBranch.split("/") if (stringArray.length > 0) { return stringArray[stringArray.length - 1] } else { return "UnKnown Branch" } } else { return 'git symbolic-ref --short -q HEAD'.execute().text.trim() } } /** * 获取Git 版本号 */ def getGitSHA() { return 'git rev-parse --short HEAD'.execute().text.trim() } /** * 获取Git Tag */ def getGitTag() { return 'git describe --tags'.execute([], project.rootDir).text.trim() } /** * 获取Git 提交次数 */ def getGitCommitCount() { return 100 + Interger.parse('git rev-list --count HEAD'.execute([], project.rootDir).text.trim()) } /** * 判断是否有jenkins */ boolean isInJenkins() { Map<String, String> map = System.getenv() if (map == null) { return false } String str = map.get("Path") if (str != null) { //it's windows return false } else { str = "" Iterator it = map.iterator() while (it.hasNext()) { str += it.next() } return str.contains("jenkins") } } /** * 获取jenkins任务名 */ def getJenkinsName() { boolean flag = isInJenkins() if (flag) { ext.env = System.getenv() ext.name = env.JOB_URL String[] stringArray = ext.name.split("/") if (stringArray.length > 0) { return stringArray[stringArray.length - 1] } else { return "Local" } } else { return "Local" } } /** * 获取Jenkins Build 号 * @return */ def getJenkinsBuildCode() { boolean flag = isInJenkins() if (flag) { ext.env = System.getenv() ext.buildNumber = env.BUILD_NUMBER?.toInteger() return "$buildNumber" } else { return 0 } } /** * 定义几个变量，在build.gradle里面引用 */ ext { gitTag = getGitTag() gitBranch = getGitBranch() gitSHA = getGitSHA() jenkinsRevision = getJenkinsBuildCode() jenkinsName = getJenkinsName() }

如今测试下Jenkins编译是否正常，能够看到一切都正常了。

这里写图片描述

参考连接

这里写图片描述

做者：欧阳鹏 欢迎转载，与人分享是进步的源泉！
转载请保留原文地址：http://blog.csdn.net/ouyang_peng/article/details/77802596

若是以为本文对您有所帮助，欢迎您扫码下图所示的支付宝和微信支付二维码对本文进行随意打赏。您的支持将鼓励我继续创做！

这里写图片描述

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程