JIRA 4.0 : Building JIRA from Source
This page last changed on Sep 21, 2009 by trahilly.
Commercial users receive access to JIRA source. This documentation shows how to build the JIRA source back into an application that can be deployed. You would only be interested in this documentation if you are making modifications to the JIRA source code. Changes to JSP files do not require rebuilding JIRA. Also, you should be aware of the possibilities the plugin system affords — often changes can be developed and packaged as a plugin without requiring core source modifications. Building JIRA WAR from JIRA Source release
Developing using Intellij IDEAIf you are an IDEA user, you may wish to use the atlassian-idea plugin we have developed to quickly generate a work environment. Building the Atlassian source dependenciesJIRA's source distribution not only ships with JIRA's source code, it also includes the source of the internal Atlassian projects that JIRA depends on (e.g. atlassian-bonnie, atlassian-core, etc.). These dependencies are included in JIRA in binary format when you build the JIRA source (they are downloaded from the Atlassian maven repository). You can, however, compile the provided source to generate the binaries yourself. These projects use a mix of Maven 1 and Maven 2 build systems to compile and package their source. You can tell a project uses Maven 1 if the project contains a file called 'project.xml' in the top level directory. If a project uses Maven 2, it will contain a file called 'pom.xml' in the top level directory. Building a Maven 1 project you will invoke 'maven jar', whereas for a Maven 2 project you will invoke 'mvn package'. In order to run the 'mvn' command you will have to install Maven 2. Please follow the general instructions regarding setting up a development environment. Please note that you will also have to add the Atlassian Maven 2 repository to your Maven 2 configuration. To do this you will need to edit your settings.xml as described in Maven Requirements. You should also install the following dependencies ("mail", "activation" and "transaction" APIs) that are not re-distributable before attempting a build: mvn install:install-file -DgroupId=javax.mail -DartifactId=mail -Dversion=1.3.2 -Dpackaging=jar -Dfile=$HOME/Downloads/mail-1.3.2.jar mvn install:install-file -DgroupId=javax.activation -DartifactId=activation -Dversion=1.0.2 -Dpackaging=jar -Dfile=$HOME/Downloads/activation-1.0.2.jar mvn install:install-file -DgroupId=javax.transaction -DartifactId=jta -Dversion=1.0.1B -Dpackaging=jar -Dfile=$HOME/Downloads/jta-1_0_1B-classes.zip Obtaining the source of JIRA's dependenciesMost of JIRA's dependencies are either shipped in binary (compiled) form with the source distribution, or are available on Maven's public repository. Maven will fetch the dependencies that it requires automatically during the build process, so you do not have to do it manually. Hence, you do not need the source of every dependency to build JIRA from source. However, sometimes you might want to "look inside" these dependencies. If so, this section is for you. The source distribution of JIRA is shipped with a project.xml file. All of JIRA's dependencies are listed inside this file. Most of the dependencies are open source libraries but some are Atlassian's code. All of the Atlassian code is included in the source distribution. The source of the other dependencies is usually available on the library's website (try googling for the library name). In some cases JIRA uses unofficial 'snapshot' releases of a library, sometimes additionally patched to fix bugs or add features. In these cases the library source can be obtained from Atlassian's repository, at http://repository.atlassian.com/ dependencyId /distributions/, where dependencyId is the dependency name found in the project.xml record. For example, source for the dependency: <dependency> <id>javacvs</id> <version>20050531-patched</version> <properties> <war.bundle>true</war.bundle> </properties> </dependency> can be found at http://repository.atlassian.com/javacvs/distributions/javacvs-20050531-patched-src.tar.gz. If source modifications were made, a patch is usually available at http://repository.atlassian.com/ dependencyId /patches/ If you have any questions regarding the build process, please post to the JIRA Development Forum, which is monitored continually by the development community, and by Atlassian as often as possible. Compiling classes into JIRA StandaloneIf you just want to compile one class (perhaps a service) and you're using the JIRA Standalone distribution, there is an Ant-based mini-build system available in the external-source directory. See JIRA Standalone quick source modifications for details. |
![]() |
Document generated by Confluence on Oct 06, 2009 00:26 |