WIP: provide COMMIT_MESSAGE as an env var #796

jeff-knurek · 2019-12-11T11:57:02Z

JENKINS-52490 - Plugin should provide GIT_COMMIT_MESSAGE as Environment Variable

The commit message should be available as an env var.

Checklist

I have read the CONTRIBUTING doc
I have referenced the Jira issue related to my changes in one or more commit messages
I have added tests that verify my changes
Unit tests pass locally with my changes
I have added documentation as necessary
No Javadoc warnings were introduced with my changes
No spotbugs warnings were introduced with my changes
I have interactively tested my changes

Types of changes

New feature (non-breaking change which adds functionality)

vwin · 2019-12-20T09:05:00Z

I think so ~

MarkEWaite

This looks reasonable, though I think you may want to name the variable GIT_COMMIT_TITLE rather than GIT_COMMIT_MESSAGE based on the description in the git commit manual page where it says:

The text up to the first blank line in a commit message is treated as the commit title, and that title is used throughout Git. (emphasis added)

That would allow a future addition to deliver GIT_COMMIT_MESSAGE as the full message rather than only the first line of the message.

Also needs one or more tests to confirm that it is well-behaved.

MarkEWaite · 2019-12-21T00:21:42Z

src/main/java/hudson/plugins/git/GitSCM.java

    }

+


Please don't add extra white space in a change. The white space is already messy enough in the plugin without adding duplicated empty lines

Suggested change

jeff-knurek · 2019-12-30T08:39:34Z

I've updated with the documentation bits that seem to be needed. I've also added a test, but the test doesn't actually pass. Spent some time trying to debug it, but may need to take a different approach.

* rename the env var to be aligned with the git description * test isn't working yet as expected, still need more investigation into why Signed-off-by: Jeff Knurek <[email protected]>

otradovec · 2020-01-03T13:44:37Z

@jeff-knurek I don't understand why are you asserting String with Env object. Maybe you wanted
assertEquals("Commit message should be an env var", title, getEnvVars(p).get("some_key","default"));
But I am a newbie, so I am missing something propably.

Signed-off-by: Jeff Knurek <[email protected]>

jeff-knurek · 2020-01-06T09:18:59Z

@otradovec you're totally right. I had pushed some in-progress code from while I was debugging the test. I've now pushed what I expect to work (but doesn't)

otradovec · 2020-01-06T10:50:37Z

What about using GIT_COMMIT instead? I don't see GIT_COMMIT_TITLE here https://javadoc.jenkins.io/plugin/git/hudson/plugins/git/GitSCM.html
Or is that defined somewhere else?

otradovec · 2020-01-06T10:54:34Z

Btw this: https://javadoc.jenkins-ci.org/hudson/model/Run.html#getEnvVars--
getEnvVars is deprecated, Use getEnvironment(TaskListener) instead.

jeff-knurek · 2020-01-06T13:36:06Z

GIT_COMMIT_TITLE is what I'm adding in this PR

Your tip about getEnvVars being deprecated gave me an idea, but it still didn't work.
Because right now, the getEnvVars is actually this one, based off the builder, and not the run:
https://github.com/jenkinsci/git-plugin/blob/master/src/test/java/hudson/plugins/git/AbstractGitTestCase.java#L282
so I tried using the one from the run, but it also doesn't have the new Env Var :(

maneetgoyal · 2020-03-26T20:13:19Z

Hi @MarkEWaite, is there anything remaining for this PR? It's a useful feature.

jeff-knurek · 2020-03-27T08:40:12Z

I never got the unit tests to work. I think that's pretty critical to get this out. I'm not a Java/Jenkins developer though, so I think I've run out of things to try.

raghavgarg098 · 2021-02-25T17:12:47Z

src/test/java/hudson/plugins/git/GitSCMTest.java

@@ -3064,6 +3064,24 @@ public void testCommitMessageIsPrintedToLogs() throws Exception {
        assertThat(values, hasItem("Commit message: \"test commit\""));
    }

+    @Test
+    public void testCommitMessageIsEnvVar() throws Exception {


Similar to this I was trying to set environment variable for https://issues.jenkins.io/browse/JENKINS-38699. Does this test case run correctly in the current state?

raghavgarg098 · 2021-04-16T09:35:15Z

src/main/java/hudson/plugins/git/GitSCM.java

@@ -1352,6 +1353,9 @@ public void checkout(Run<?, ?> build, Launcher launcher, FilePath workspace, Tas

        // Needs to be after the checkout so that revToBuild is in the workspace
        try {
+            String shortMessage = getCommitMessage(listener, git, revToBuild);
+            listener.getLogger().println("Commit message: \"" + shortMessage + "\"");
+            environment.put(GIT_COMMIT_TITLE, shortMessage);


@MarkEWaite In this(https://github.com/jenkinsci/git-plugin/pull/1049/files#r583842074) pull request you mentioned with this enviroment variable is set only for the process.
I want to understand what is the scope of adding a variable to EnvVars is? Since it is being added in git plugin would it be available to just the checkout step or it will be available in subsequent steps like build etc. ? From the bug description I believe we want to use this env variable to check if we want to run the build step based on the commit message. So would this env variable be available in the pipeline script in the build step with this ?

MarkEWaite · 2021-07-10T23:28:01Z

Closing in favor of #1074

MarkEWaite requested changes Dec 21, 2019

View reviewed changes

Jeff Knurek added 2 commits December 30, 2019 09:41

provide COMMIT_MESSAGE as an env var

aa8a6ae

[JENKINS-52490] add more documentation, and test for the new env var

536b177

* rename the env var to be aligned with the git description * test isn't working yet as expected, still need more investigation into why Signed-off-by: Jeff Knurek <[email protected]>

jeff-knurek force-pushed the commit-message branch from a675ff4 to 536b177 Compare December 30, 2019 08:44

MarkEWaite added the enhancement Improvement or new feature label Dec 31, 2019

push the assert that was intended to be working

45d2c70

Signed-off-by: Jeff Knurek <[email protected]>

Merge branch 'master' into commit-message

7c3ac66

raghavgarg098 reviewed Feb 25, 2021

View reviewed changes

raghavgarg098 reviewed Apr 16, 2021

View reviewed changes

raghavgarg098 mentioned this pull request Apr 17, 2021

Provide GIT_COMMIT_TITLE as environment variable #1074

Open

11 tasks

MarkEWaite closed this Jul 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: provide COMMIT_MESSAGE as an env var #796

WIP: provide COMMIT_MESSAGE as an env var #796

jeff-knurek commented Dec 11, 2019 •

edited

Loading

vwin commented Dec 20, 2019

MarkEWaite left a comment •

edited

Loading

MarkEWaite Dec 21, 2019

jeff-knurek commented Dec 30, 2019

otradovec commented Jan 3, 2020

jeff-knurek commented Jan 6, 2020

otradovec commented Jan 6, 2020

otradovec commented Jan 6, 2020 •

edited

Loading

jeff-knurek commented Jan 6, 2020

maneetgoyal commented Mar 26, 2020

jeff-knurek commented Mar 27, 2020

raghavgarg098 Feb 25, 2021

raghavgarg098 Apr 16, 2021

MarkEWaite commented Jul 10, 2021

WIP: provide COMMIT_MESSAGE as an env var #796

WIP: provide COMMIT_MESSAGE as an env var #796

Conversation

jeff-knurek commented Dec 11, 2019 • edited Loading

JENKINS-52490 - Plugin should provide GIT_COMMIT_MESSAGE as Environment Variable

Checklist

Types of changes

vwin commented Dec 20, 2019

MarkEWaite left a comment • edited Loading

Choose a reason for hiding this comment

MarkEWaite Dec 21, 2019

Choose a reason for hiding this comment

jeff-knurek commented Dec 30, 2019

otradovec commented Jan 3, 2020

jeff-knurek commented Jan 6, 2020

otradovec commented Jan 6, 2020

otradovec commented Jan 6, 2020 • edited Loading

jeff-knurek commented Jan 6, 2020

maneetgoyal commented Mar 26, 2020

jeff-knurek commented Mar 27, 2020

raghavgarg098 Feb 25, 2021

Choose a reason for hiding this comment

raghavgarg098 Apr 16, 2021

Choose a reason for hiding this comment

MarkEWaite commented Jul 10, 2021

jeff-knurek commented Dec 11, 2019 •

edited

Loading

MarkEWaite left a comment •

edited

Loading

otradovec commented Jan 6, 2020 •

edited

Loading