Jenkins Workflow插件中的Git变量

时间:2016-02-22 13:30:39

标签: git jenkins groovy jenkins-pipeline

当我从构建流中的git中检出存储库时,我想访问git变量,例如GIT_COMMITGIT_BRANCH。目前我找不到可用的变量来访问这两个参数。

node {
    git git+ssh://git.com/myproject.git
    echo "$GIT_COMMIT - $BRANCH_NAME"
}

这些变量是否可用,万一,我会在哪里找到它们。我不介意他们是否可以通过一些常规变量或任何地方,只是我可以访问它们。

也许我缺乏Groovy的调试技巧,这很容易找到,但我只是用我有限的技能找不到它。

8 个答案:

答案 0 :(得分:30)

根据您使用的SCM插件,checkout步骤可能会返回有关修订的其他信息。这已在JENKINS-26100中得到解决。它已在2.6 version of the workflow-scm-step plugin中发布。

例如,使用Git插件,您可以执行以下操作:

final scmVars = checkout(scm)
echo "scmVars: ${scmVars}"
echo "scmVars.GIT_COMMIT: ${scmVars.GIT_COMMIT}"
echo "scmVars.GIT_BRANCH: ${scmVars.GIT_BRANCH}

这取决于您使用的插件,因此原始答案可能会更适合您。

原始答案

使用Pipeline Nodes and Processes Plugin的2.4版本,您只需执行以下操作:

def gitCommit = sh(returnStdout: true, script: 'git rev-parse HEAD').trim()

答案 1 :(得分:8)

根据example provided in the Jenkins examples repo

,这就是我正在做的事情
node {
    git url: 'https://git.com/myproject.git'

    sh 'git rev-parse --abbrev-ref HEAD > GIT_BRANCH'
    git_branch = readFile('GIT_BRANCH').trim()
    echo git_branch

    sh 'git rev-parse HEAD > GIT_COMMIT'
    git_commit = readFile('GIT_COMMIT').trim()
    echo git_commit
}

修改您可以通过

缩短时间
git_commit = sh(returnStdout: true, script: "git rev-parse HEAD").trim()

答案 2 :(得分:6)

根据您需要的信息,有一个非常简单的解决方案:获取“checkout scm”操作返回:它提供GIT_BRANCH,GIT_COMMIT,GIT_PREVIOUS_COMMIT,GIT_PREVIOUS_SUCCESSFUL_COMMIT和GIT_URL。

node { 
    stage ("Checkout") {

        scmInfo = checkout scm

        /*...*/
        echo "scm : ${scmInfo}"
        echo "${scmInfo.GIT_COMMIT}"


    }
}

这将输出:

...
[Pipeline] echo
    scm : [GIT_BRANCH:my-branch, GIT_COMMIT:0123456789abcdefabcdef0123456789abcdef01, GIT_PREVIOUS_COMMIT:aaaabbbcccdddeeeefffe0123456789012345678, GIT_PREVIOUS_SUCCESSFUL_COMMIT:aaaabbbcccdddeeeefffe0123456789012345678, GIT_URL:http://my.si.te/my-repository.git]
[Pipeline] echo
    0123456789abcdefabcdef0123456789abcdef01
...

此处有更多详情Jenkins Pipeline SCM Steps

答案 3 :(得分:1)

这个例子可能会让你更进一步: https://github.com/jenkinsci/pipeline-examples/tree/master/pipeline-examples/gitcommit

在这个例子中,他们将git命令的输出传递给一个文件,然后读取该文件。

答案 4 :(得分:1)

您可以在node内定义作业(从上次提交中提取git信息),以便在队列中执行。

node {

  //Code checkout from SCM (here - `git`)
  checkout scm

  stage("GIT INFO"){
    echo ":::::::::::GIT_SHORT_COMMIT::::::::::::::::::::::::"

    GIT_SHORT_COMMIT = sh(returnStdout: true, script: "git log -n 1 --pretty=format:'%h'").trim()
    //echo in jenkins console
    echo GIT_SHORT_COMMIT
    //wanted to send these info to build artifacts, append to any file
    sh("echo ${GIT_SHORT_COMMIT} > GIT_SHORT_COMMIT")

    //Similar proceed for other git info's 
    echo ":::::::::::GIT_COMMITTER_EMAIL::::::::::::::::::::::::"

    GIT_COMMITTER_EMAIL = sh(returnStdout: true, script: "git show -s --pretty=%ae").trim()
    sh("echo ${GIT_COMMITTER_EMAIL} > GIT_COMMITTER_EMAIL-${GIT_COMMITTER_EMAIL}")



    echo ":::::::::::GIT_COMMITTER_NAME::::::::::::::::::::::::"

    GIT_COMMITTER_NAME = sh(returnStdout: true, script: "git show -s --pretty=%an").trim()
    sh("echo ${GIT_COMMITTER_NAME} > GIT_COMMITTER_NAME-${GIT_COMMITTER_NAME}")
  }

作业完成后,您将在工作区中看到上述任务中的另外三个文件:

. |-- GIT_COMMITTER_EMAIL_email@gmail.com |-- GIT_COMMITTER_NAME-username |-- GIT_SHORT_COMMIT_<commit-short-ID-ef9e91c>

答案 5 :(得分:0)

我现在解决这个问题的好方法是使用多分支管道,并且知道Bitbucket和Github在Jenkins中设置了一个组织并自动发现新项目的插件可能会很好。这与env.GIT_BRANCH

本身有效

对于提交ID,我会建议@mkobit在上面写的内容。

答案 6 :(得分:0)

通过Jenkinsfile获取Jenkins中的Git变量的最简单方法

node {
  def scmVars = checkout scm
  echo 'scm : the commit id is ' +scmVars.GIT_COMMIT
  echo 'scm : the commit branch  is ' +scmVars.GIT_BRANCH
  echo 'scm : the previous commit id is ' +scmVars.GIT_PREVIOUS_COMMIT
  def commitEmail = sh(returnStdout: true, script: "git --no-pager show -sformat=\'%ae\'")
  echo " the commiter email is'${commitEmail}'"
  def commitName = sh(returnStdout: true, script: "git --no-pager show -s format=\'%an\'")
  echo " the commiter name is'${commitName}'"
}

在控制台中,您将获得

GIT_COMMIT:
GIT_BRANCH:
GIT_PREVIOUS_COMMIT:
commitEmail:
commitName:

答案 7 :(得分:0)

附加信息: 如果您正在使用代理,例如管道中的 docker,则代理应该在容器内安装 git。没有 git,它不会添加诸如“GIT_COMMIT、GIT_BRANCH、GIT_COMMITTER_EMAIL ...等”之类的变量

如果容器内没有安装 git,你可以使用 Jenkins git 插件进行 checkout 并与 git 变量交互,如下所示:

stage ('Clone') {
  steps {
    script {
      def scmVars = checkout BbS(branches: [[name: '*/develop']], credentialsId: 'bitbucket-jenkins', extensions: [], gitTool: 'default-git', id: '436fd534-c616-4a81-94d9-f67f32c03c1c', projectName: 'intuence-discovery-analysis-configuration', repositoryName: 'api-gateway-elasticsearch-proxy', serverId: 'b4943a46-b885-4aa3-90be-033e40460794')
      echo "scmVars.GIT_COMMIT"
      echo "${scmVars.GIT_COMMIT}"
      env.GIT_COMMIT = scmVars.GIT_COMMIT
      sh "printenv"
    }
  }
}