如何在 Jenkins 声明式管道的 post 阶段和 emailext 中访问 $GIT_COMMIT？

Question

我想在构建成功/失败时发送电子邮件以及一些有用的 Git 信息，例如提交 SHA、先前成功的 SHA、提交消息等。 我能够以旧的 UI 方式做到这一点，但现在我已经创建了声明性管道，现在我在收到的电子邮件中收到了 GIT_BRANCH is not supported in this context。我正在使用 Jenkins 版本。 2.89.3。 我的脚本：

pipeline {
    agent { 
        ...
    }
    stages {
        stage('Checkout') {
            steps {
                sh 'printenv'
                checkout scm: [$class: 'GitSCM', branches: [[[name: '*/development']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [url: 'https://github.com/myrepo/']]]
                sh 'git submodule foreach --recursive \'git submodule sync\''
                sh 'git submodule update --init --recursive'
            }
        }
        stage('Build') {
            steps {
               ...         
            }
        }
    }
    post {
        success {
            sh 'printenv'
            emailext body: '$PROJECT_DEFAULT_CONTENT Commit message: ${FILE, path="commit_message.txt"}\nThis commit: ${GIT_COMMIT}Build URL: ${BUILD_URL}',
            recipientProviders: [[$class: 'DevelopersRecipientProvider'], [$class: 'CulpritsRecipientProvider'], [$class: 'RequesterRecipientProvider']],
            subject: 'Some subject'
        }
    }
}

printenv 将打印我期望的所有内容，包括在“结帐”阶段和成功后的 GIT_COMMIT。因为我将在 10 多个 Jenkins 作业中重复使用这个脚本，所以我想避免添加手动 UI 工作来传递参数和东西。

我尝试在stages 之前声明环境，但无法从emailext 的上下文中使用它：

agent {
    ...
}
environment {
    MY_GIT_COMMIT = "${GIT_COMMIT}"
}
stages {
    ...
}

感谢任何帮助。提前致谢。

Answer 1

另一种方法是使用命令替换，这对我们有用：

post {
        success {
        sh  '''    
            echo "Commit $(git rev-parse HEAD)" | mail -s "Deployment completed successfully" ADDRESS@EMAIL.COM
            '''                  
        }
    }

Answer 2

您可以通过以下方式执行此操作 - 尽管这可能不适用于声明性管道，但也许它会给您一些东西 - 从多分支管道设置...

node("my-node") {

    withCredentials([string(credentialsId: 'my-credential-id', variable: 'MY_CREDENTIAL')]) {

    def commitHash = checkout(scm).GIT_COMMIT

    stage ("stage 1") {
        // …
    }

}

或在一个阶段内（对我来说效果更好），

node("my-node") {
    def scmVars

    stage("stage-1") {
        scmVars = git branch: env.BRANCH_NAME, credentialsId: 'my-git-credentials', url: 'https://myrepo.git'

        commitHash = scmVars.GIT_COMMIT
    }
}

我更喜欢在一个阶段，因为checkout(scm).GIT_COMMIT 将获得目标分支的合并提交，而不是来自 PR 的最新提交

Answer 3

JENKINS-26100 建议

node {
    withCheckout(scm) {
         echo "GIT_COMMIT is ${env.GIT_COMMIT}"
    }
}