Where are the instance variables coming from on the email-ext jelly/groovy scripts?

Question

The templates and examples provided by the email-ext plugin on jenkins reference variables such as build, root, it, etc.... Where are these variables coming from and where is the documentation on them? I understand to some extent that it is the reference to the plugin instance, but that's about where my understanding ends.

If you need reference to the scripts you can see some examples here: https://github.com/jenkinsci/email-ext-plugin/tree/master/src/main/resources/hudson/plugins/emailext/templates

Cerenkov

Answer 1

build: hudson.model.AbstractBuild - your build instance.

project == build.getParent() - the job instance for your build.

it: ScriptContentBuildWrapper(build) (internal ExtEmail class)

rootUrl Jenkins URL as set in your Jenkins configuration

template: template name

Here is EmailExt plugin code link. What you are looking for is in the method ScriptContent.createEngine().

For reference, here is Jenkins API link.

Carmencarmena

When using a build step "Execute system Groovy script" the variable rootURL does not exist. I'm using this helper function: def getRootUrl(useAbsoluteUrl=false) { ` def instance = Jenkins.getInstance()` ` return useAbsoluteUrl ? instance.getRootUrl()` ` : (instance.servletContext.getContextPath()+"/")` } – Lahey

And the class where the is 'build', 'it', 'project' etc names are actually set to refer to their real objects is here - the JellyScriptContent class: github.com/jenkinsci/email-ext-plugin/blob/… – Arbitration