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

2017-09-01 838

一、背景

因为代码都迁移到了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编译的时候，一直获取不到信息。

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

/**
 * 获取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分支名。

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

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

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

但是在Jenkins编译的时候，是不能够上传的，如下所示：

二、解决方法

后来我尝试找了很多种方法去获取Git Branch的名字，在Android Studio本地都可以获取到，如下所示：

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

方法1、git symbolic-ref --short -q HEAD

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

D:\GitLab Source\XTCLint>

方法2、git rev-parse --abbrev-ref HEAD

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

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

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

方法4、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

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

微信关注我们

原文链接：https://yq.aliyun.com/articles/240136

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

ReactNative环境搭建扩展篇——安装后报错解决方案

之前一篇写了《逻辑性最强的React Native环境搭建与调试》说了RN的安装，今天在这里做一个复盘，让我们能够更直观更深入的了解React Native（以下简称RN）,这一篇重点来说的就是，安装之后必报的2个错误的解决方案。更新日期：2017.9.2 运行环境：Windows 10/Android环境一、回顾一下RN的安装过程： 1.搭建Android开发环境，因为要运行在Android环境下，所有安卓的开发环境是要搭建的。具体的步骤请搜索度娘！（配置JDK、安装SDK Manager组件等）； 2.ReactNative（下文简称RN）因为是基于nodejs框架的，所以需要安装nodejs开发环境，包括：nodejs运行库6.x+、npm3+、python2.x； 3.需要初始化RN项目所以需要安装Git版本控制器； 4.以上步骤执行完成之后，就可以创建RN项目了，创建并运行项目需要以下几个步骤： a).创建项目，执行命令：react-native init xxx(项目名称)； b).在模拟器或手机安装app：进入项目根目录执行命令：react-native run...

2017-09-02

657

新开一个安卓坑, 此坑的内容来自在Google中国开发者面向Android初学者的论坛http://www.studyjamscn.com 准备工作 Windows10Java Development Kit8Android Studio2.3.3Gradle4.1(后面会讲到, 可以先不下载) 建立工程 Step1 建立工程的第一步这里之所以使用Company domain的逆序作为包名, 是因为域名的唯一性, 这个唯一性是我们之后发布应用到应用商店的身份证明. 有的小伙伴可能会想, 我没有域名怎么办? 不用担心, 我们还可以用通过博客地址,微博地址这些来曲线救国, 现在支持个性域名的网站已经不少. Company domain Step2 选择SDK的时候, 如图中所示, 百分数是指目前在Google Play中此版本到最新版本的手机覆盖率之和, 为了应用能有更好的覆盖面, 我们应该在保证大部分新API能用的情况下, 提高覆盖率. 而不是一味的求覆盖率. 有些功能如Google Pay等不在2.X的Android版本中提供, 这意味着你的应用不能使用相关的api SDK选择点击H...

2017-09-03

661

资源下载

更多资源

优质分享App

近一个月的开发和优化，本站点的第一个app全新上线。该app采用极致压缩，本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Nacos

Nacos /nɑ:kəʊs/ 是 Dynamic Naming and Configuration Service 的首字母简称，一个易于构建 AI Agent 应用的动态服务发现、配置管理和AI智能体管理平台。Nacos 致力于帮助您发现、配置和管理微服务及AI智能体应用。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据、流量管理。Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能，例如代码缩略图，Python的插件，代码段等。还可自定义键绑定，菜单和工具栏。Sublime Text 的主要功能包括：拼写检查，书签，完整的 Python API ， Goto 功能，即时项目切换，多选择，多窗口等等。Sublime Text 是一个跨平台的编辑器，同时支持Windows、Linux、Mac OS X等操作系统。

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

一、背景

二、解决方法

参考链接

ReactNative环境搭建扩展篇——安装后报错解决方案

Android笔记——My First App

相关文章

发表评论

资源下载

优质分享App

Nacos

Rocky Linux

Sublime Text

欢迎您来访！

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

一、背景

二、解决方法

参考链接

ReactNative环境搭建扩展篇——安装后报错解决方案

Android笔记——My First App

相关文章

发表评论

资源下载

优质分享App

Nacos

Rocky Linux

Sublime Text

欢迎您来访！

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