如何在自定义Jenkins插件中获取GIT_COMMIT变量？

在Jenkins流水线场景下，build.getEnvironment()无法获取到GIT_COMMIT的核心原因是：流水线的环境变量是在Agent节点执行阶段注入的，而build.getEnvironment(null)获取的是控制器端的全局环境，不包含节点级别的SCM相关变量。下面提供两种可靠的解决方案，优先推荐直接从SCM获取的方式。

方案一：直接从Git SCM获取提交哈希（推荐） #

不管是自由风格还是流水线构建，只要配置了Git作为SCM，构建的版本信息都会被Jenkins存储在Run对象的SCM关联数据中。直接读取这些数据可以避免环境变量的依赖问题，兼容性更强。

代码示例 #

import hudson.model.Run;
import hudson.plugins.git.GitSCM;
import hudson.plugins.git.Revision;
import hudson.plugins.git.util.BuildData;

public class MyCustomPlugin {
    public void getGitCommit(Run<?, ?> build) {
        // 遍历构建关联的所有SCM，寻找GitSCM实例
        for (Object scmObj : build.getSCMs()) {
            if (scmObj instanceof GitSCM) {
                // 获取GitSCM对应的构建数据
                BuildData buildData = build.getAction(BuildData.class);
                if (buildData != null) {
                    Revision lastRevision = buildData.getLastBuiltRevision();
                    if (lastRevision != null && lastRevision.getSha1() != null) {
                        // 提取Git提交哈希
                        String gitCommit = lastRevision.getSha1().getName();
                        System.out.println("GIT_COMMIT (从SCM获取): " + gitCommit);
                        return;
                    }
                }
            }
        }
        System.out.println("无法从SCM获取GIT_COMMIT");
    }
}

注意事项 #

• 需要在插件的依赖中添加Jenkins Git插件的依赖（pom.xml中）：

<dependency>
    <groupId>org.jenkins-ci.plugins</groupId>
    <artifactId>git</artifactId>
    <version>5.2.0</version> <!-- 使用与目标Jenkins版本兼容的Git插件版本 -->
    <scope>provided</scope>
</dependency>

• 该方法不依赖环境变量，只要构建配置了Git SCM就能稳定获取到提交哈希，不受流水线执行上下文的影响。

方案二：从流水线环境变量获取（局限性较大） #

如果必须通过环境变量获取，需要确保插件的逻辑是在Agent节点上执行的（比如作为流水线步骤运行），此时可以通过StepContext获取节点环境，而不是直接调用build.getEnvironment()。

代码示例（仅适用于流水线步骤类） #

import org.jenkinsci.plugins.workflow.steps.StepContext;
import hudson.EnvVars;

public class MyPipelineStep extends Step {
    @Override
    public StepExecution start(StepContext context) throws Exception {
        return new Execution(context);
    }

    private static class Execution extends SynchronousStepExecution<Void> {
        protected Execution(StepContext context) {
            super(context);
        }

        @Override
        protected Void run() throws Exception {
            // 获取Agent节点的环境变量
            EnvVars envVars = getContext().get(EnvVars.class);
            String gitCommit = envVars.get("GIT_COMMIT");
            if (gitCommit != null) {
                System.out.println("GIT_COMMIT (从环境变量获取): " + gitCommit);
            } else {
                System.out.println("环境变量中未找到GIT_COMMIT");
            }
            return null;
        }
    }
}

局限性 #

• 仅适用于作为流水线步骤运行的插件逻辑，无法在控制器端的通用逻辑中使用
• 需要用户的流水线明确配置了Git相关的环境变量注入（比如使用git步骤拉取代码）
• 兼容性较差，不同版本的Git插件或流水线语法可能导致变量未被注入

两种方案对比 #

优先选择直接从SCM获取的方案，能最大程度保证插件在自由风格和流水线场景下的一致性和稳定性。

内容的提问来源于stack exchange，提问作者Bhavya Latha Bandaru