Building the Zendesk JIRA plugin

Description on how to setup the development environment for the Zendesk JIRA pluginTo build the jar file use:

1. Configure settings.xml
2. Install sun dependencies
3. Build the plugin as: mvn package -Paltlassian -Pgreenpepper -Pregression-test

Setup integration test environment

To run the integration test the corresponding JIRA versions need to be installed, and the Maven build environment configured to use these installations. The seps to achieve this is:

• Download and install the relevant JIRA version.
• Set the ${jira.install} property to point to the directory the test JIRA are installed into:

  <properties>
      ....
      <jira.install>D:\apps\jira-test</jira.install>
  </properties>
  

• (JIRA4) Set the JIRA home directory to point to the home folder in the ${jira.install} directory.

  Enable JIRA debugging

• Update the bin/catalina.bat(.sh) with

  set JPDA_TRANSPORT=dt_socket
  set JPDA_ADDRESS=8000
  

• Update the call to catalina.bat(sh) to call the jpda start cmd instead of the start cmd. Eg. change

  call "%EXECUTABLE%" start %CMD_LINE_ARGS% 

  to

  call "%EXECUTABLE%" jpda start %CMD_LINE_ARGS%

Other types of builds

Eclipse debugging

Local JIRA

• To run the test and debug the integration test towards the embedded JIRA, this needs to be started and debug enable, like this:

  mvn install -Dmaven.test.skip=true -Djira.wait=true -Pplugin-debug

  .

• Run the integration tests from Eclipse. Attach to port 5006 for debugging.

Note: The local jira will be run from a debug folder directly in the project root, when the plugin-debug profile is enabled. This means that a mvn clean wouldn't clean the debug jira installation, this needs to be manually deleted.

Remote JIRA

Alternatively you kan run the integration test towards a independent JIRA installation by.

• Start your JIRA installation with debug enabled.
• Deploy the zendesk plugin with:

  mvn install -Dmaven.test.skip=true -Pdeploy2test

• Configure the listener settings as descibed in the installation guide #6.
• Setting the zendesk.jira.url, zendesk.jira.login.name, zendesk.jira.login.password properties to the relevant values for accessing your JIRA. installation.
• Run the integration tests from Eclipse.

Clover report

Not implemented yet, see ZEN-26 Enable Clover coverage

To enabled clover coverage, copy the clover.license file to the ~/.m2 folder

Generate the site target with clover report as:

mvn clean clover2:instrument site

For further details see:

• Build lifecycle — The project specific lifecycle functionality
• Build profiles — The following relevant profiles are defined
• Build properties — List of useful properties
• Configure settings.xml — Describes the sections needed in Maven settings.xml to build the plugin
• Deployment — The deployment to the test server, the maven repository and maven site repository
• Install sun dependencies — The JIRA plugin development environment has a couple of sun jar dependencies which can't be found in any public maven repositories because of their proprietary nature. Instead they have to be downloaded manually and installed in the local maven repository
• ssh access configuration — Description of how to access the [development servers] without the need to use a password. This is useful for scripting access

Unresolved build issues