How to show executed build plan variable values in notification email template?

The use case is simple: 

- At the end of a build plan run (ie. Build Release), there is a versions.txt file that gets generated and I want to have the contents of that file presented in the "All Completed Builds" notification email subject line.

I can thus far:

- Extract the contents of that file and inject them as bamboo variables using the "Inject Bamboo variables" Task or simply print them to screen/logs.

- Modify the notification template files (.ftl)

Where I'm stuck is identifying the bamboo objects referencing these 'injected variables'.  Even some of the built-in bamboo variables ie. ( ${bamboo.build.working.directory} ) don't work as objects in the Freemarker markup templates.

There must be an easy way to show desired build version info of a given build plan in the notification email subject line (and no, ${bamboo.buildNumber} is not it).

Any help would be appreciated.

1 answer

0 vote

Based on Modifying notification templates, I think you'll need to explore the Java interfaces that are backing the Freemarker ${buildSummary} and ${deploymentResult} variables, i.e. the Java BuildResultsSummary and DeploymentResult interfaces respectively.

The former provides an Iterable getResultVariables() in turn, which might be what you are looking for - Carolyn van Slyck's Bamboo Deployment Notifications provides examples how to conceptually access those interfaces from Freemarker (albeit only for ${deploymentResult}), e.g. in template EmailSubject.ftl:

[#-- @ftlvariable name="deploymentResult" type="com.atlassian.bamboo.deployments.results.DeploymentResult" --]
[#-- @ftlvariable name="deploymentProject" type="com.atlassian.bamboo.deployments.projects.DeploymentProject" --]
[#-- @ftlvariable name="numFailures" type="Integer" --]
[#assign deployment=deploymentProject.name /]
[#assign release=deploymentResult.deploymentVersion.name /]
[#assign environment=deploymentResult.environment.name /]
${deployment} ${release}[#t]
[#if deploymentResult.deploymentState == "Successful"] was successfully deployed to ${environment} after ${numFailures} [#if numFailures = 1]failure[#else]failures[/#if].[#rt]
[#elseif deploymentResult.deploymentState == "Failed"] failed deploying to ${environment} (${numFailures} [#if numFailures = 1]times[#else]times[/#if]).[#rt]
[#else] stopped deploying to ${environment}[#rt]
[/#if]

For a Bamboo version x.y.z installation, you can inspect the built in Freemarker deployment notification templates within the following artifact (search for *.ftl):

<bamboo-install>/atlassian-bamboo/WEB-INF/lib/atlassian-bamboo-deployments-x.y.z.jar

Thank you for the info, Steffan, and apologies on the delayed reply.

Had to move onto another task that could at least get completed.

The 'getResultVariables()' method certainly does sound like what I'm looking for, I'm still a little unclear as how these methods actually get called in the Freemarker template files (.ftl) and what variables are available as it seems not all ${bamboo.*} build variables are accessible through either BuildResultsSummary or Build classes/macros.

In any case, I will revisit this area after the holidays when I can look at it from a refreshed perspective.

Thanks again!

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Published May 18, 2017 in Bamboo

FAQ: How to Upgrade Bamboo Server

Bamboo 5.9 will no longer be supported after June 12, 2017. What does this mean? As part of our End of Life policy, Atlassian supports major versions for two years after the first major iteratio...

1,568 views 0 6
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you