Mercurial > public > JIRA
comparison ssdt-jira-plugins-v2/plugins/README.txt @ 0:92d945347fc0
V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
for JIRA 3.12.
| author | smith |
|---|---|
| date | Tue, 20 May 2008 17:11:35 -0400 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:92d945347fc0 |
|---|---|
| 1 | |
| 2 SSDT JIRA Plugin | |
| 3 ---------------- | |
| 4 | |
| 5 This project uses NetBeans with the Maven 2 plugin to build the project. | |
| 6 | |
| 7 Use the "package" goal to build the jar. | |
| 8 | |
| 9 The rest of this README is the default from the JIRA archetype. | |
| 10 | |
| 11 -------------------------------------------------------------- | |
| 12 | |
| 13 | |
| 14 | |
| 15 1. CUSTOMISE THE PLUGIN | |
| 16 | |
| 17 - Run 'mvn eclipse:eclipse' to generate an Eclipse project file. | |
| 18 - Edit pom.xml. Add information about your project, its developers and your organisation. | |
| 19 - Add dependencies as necessary | |
| 20 - Edit the plugin descriptor, src/main/resources/atlassian-plugin.xml. Add or modify plugin modules in your project. | |
| 21 - Edit the plugin code in src/main/java/ or the unit tests in src/test/java/. | |
| 22 | |
| 23 2. BUILD THE PLUGIN | |
| 24 | |
| 25 Building with your plugin with Maven is really easy: | |
| 26 | |
| 27 - Run 'mvn compile' to compile the plugin. | |
| 28 - Run 'mvn test' to run the unit tests. | |
| 29 - Run 'mvn integration-test' to run the integration tests. | |
| 30 - Run 'mvn package' to produce the JAR. | |
| 31 | |
| 32 For the above commands to skip the various test phases add one of the following options to the command: | |
| 33 | |
| 34 -Dmaven.test.skip=true - skips both unit and integration tests | |
| 35 -Dmaven.test.unit.skip=true - skips unit tests | |
| 36 -Dmaven.test.it.skip=true - skips integration tests | |
| 37 | |
| 38 XML data that is usually imported into the JIRA instance by the tests should be placed in: | |
| 39 | |
| 40 src/test/xml/ directory provided | |
| 41 | |
| 42 Packages containing integration tests should start with it. For instance: | |
| 43 it.com.atlassian.jira.plugins.fisheye.TestSomething | |
| 44 it.com.atlassian.jira.plugins.calendar.TestSomethingElse | |
| 45 | |
| 46 Hence these classes should go under src/test/java/it/directory | |
| 47 | |
| 48 The following system properties are available to control the behaviour of the integration test harness: | |
| 49 | |
| 50 tomcat.installer.url - path to the tomcat zip file to install. Default: http://repository.atlassian.com/maven2/org/apache/tomcat/apache-tomcat/5.5.20/apache-tomcat-5.5.20-jdk14.zip | |
| 51 | |
| 52 cargo.wait - if this is set o true - tomcat will be started up and then cargo would suspend allowing you to manually access this JIRA from the browser. | |
| 53 | |
| 54 jira.version - version of JIRA to compile and test against. default is 3.10.2 | |
| 55 | |
| 56 jira.data.version - version of the test resource bundle that contains the bre basic JIRA configuration data for the integration test environment. These versions mimic the actual JIRA versions. However we might only modify and release this project for the reasons of non-backwards compatibility of the new versions of JIRA. Therefore not every version of JIRA will have a corresponding version of the resource bundle. By default this is set to 3.10 which should be migrated and work correctly with the newer versions. | |
| 57 | |
| 58 jira.test-lib.version - version of jira-func-tests JAR to compile and test against. default is 3.10-DEV | |
| 59 | |
| 60 http.port - port on which this instance of JIRA will be accessible on. Default: 8989 | |
| 61 | |
| 62 jira.url - base URL for this instance of JIRA. Default: http://localhost:{http.port}/jira/ | |
| 63 rmi.port | |
| 64 | |
| 65 | |
| 66 Please remove this file before releasing your plugin. |