Kaamelot JIRA Build Kit

Kaamelot Build Kit is Maven Project providing :

• Some Build settings with configuration for below Maven plugins :
  • maven-dependency-plugin
  • maven-antrun-plugin
  • maven-install-plugin
  • maven-deploy-plugin

• An ANT Script able to build a JIRA EAR ready for Deployment.

This ANT script will :

• Extract the JIRA Distribution in Build Directory (target sub-folder)
• Integrate all changes provided by Plugin identified as Settings.
• Merge I18n Properties provided by Plugin identified as I18n Provider.
• Deploy all Added Libraries (Plugin Jar, I18n Jar or new dependencies) in JIRA Editable Libraries folder (edit-webapp/WEB-INF/lib)
• Launch of standard Atlassian JIRA ANT Build Script.

By Settings Plugin, you have to understand that it will be a JAR file providing :

• Web Resources to copy in edit-webapp/
• Resources to copy in etc/
• Sources to copy in src/
• Replacement Settings

  # List of ReplacementSet keys (comma separated) 
  replacementSets=<set1>[,<set2>]
  
  # 1st Set 
  <set1>.filePath=<Relative File Path needing Replacement>
  <set1>.<tokenSet1>=<tokenSet1>
  <set1>.<tokenSet1>.token=<tokenToReplace>
  <set1>.<tokenSet1>.value=<replacingValue>

By I18n Plugin, you have to understand that it will be a JAR file providing I18n resources.
In root of the JAR, it should provided a supportedLanguages.properties file, describing the list of provided Languages resources, and used suffix.

In below sample, two languages are supported (French and English) :

• French properties files are suffixed by fr
• English properties files are suffixed by en_UK

  # List of Language supported
  supportedLanguages=fr_FR,en_UK
  localeUsed.fr_FR=fr
  localeUsed.en_UK=en_UK

In the Integration process, the I18n resources identified as overridden properties (same name as standard properties file) will be merge with orginal one.
For example, if your I18n Plugin provides a com\atlassian\jira\web\action\JiraWebActionSupport_fr_FR.properties, then the Integration process will append your Properties at the End of the original JiraWebActionSupport_fr_FR.properties, and so, as it the Bundle Properties are managed through a HashMap, it is your translations which will be used.

To specify the JIRA Distribution to use, you will have to define in the <properties> section, a atlassian.jira.enterprise.version property as follow.

<properties>
	<atlassian.jira.enterprise.version>3.11</atlassian.jira.enterprise.version>
</properties>

The List of JIRA Plugin Settings (if needed) to merge, you will have to define in the <build> section,
a new <execution> definition for the maven-dependency-plugin as follow.

<execution>
	<id>copy.Plugins</id>
	<phase>package</phase>
	<goals>
		<goal>copy</goal>
	</goals>
	<configuration>
		<artifactItems>
			<!-- JIRA Any.Plugin Settings Module Distribution -->
			<artifactItem>
				<groupId>any.plugin.atlassian.jira</groupId>
				<artifactId>jira-plugin-any.plugin-settings</artifactId>
				<version>${jira.any.plugin.version}</version>
			</artifactItem>
		</artifactItems>
		<outputDirectory>${build.lib}</outputDirectory>
	</configuration>
</execution>

To specify which plugin provides I18n and Settings, you will have to define in the <properties> section, the properties plugins.settings and plugins.i18n, as follow.

<properties>
	<jira.any.plugin.version>1.0-SNAPSHOT</jira.any.plugin.version>

	<!-- Initialize here, the List of Settings to used for Build. Required Property : plugins.settings -->
	<plugin.any.plugin.settings>jira-plugin-any.plugin-settings-${jira.any.plugin.version}.jar</plugin.any.plugin.settings>
	<plugins.settings>${plugin.any.plugin.settings}</plugins.settings>

	<!-- Initialize here, the List of i18n to used for Build. Required Property : plugins.i18n -->
	<plugin.any.plugin.i18n>jira-plugin-any.plugin-i18n-${jira.any.plugin.version}.jar</plugin.any.plugin.i18n>
	<plugins.i18n>${plugin.any.plugin.i18n}</plugins.i18n>
</properties>

Required replacements have to be declared, specifying impacted files.
For exemple, entityengine.xml will required below replacements :

• JIRA Database Type
• JIRA Database Schema
• JIRA Dabase JNDI
• JIRA User Transaction JNDI
• JIRA Transaction Manager JNDI

This definition will be done by creating a XXX.properties file, following the description done in Concept of Settings Plugin.
Generaly, XXX is a name specifying the target environement.