Mercurial > public > JIRA

annotate ssdt-jira-plugins-v2/plugins/README.txt @ 3:e90b3c5c8df3 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve validator if work has already been logged.
author smith
date Fri, 20 Jun 2008 12:23:06 -0400
parents 92d945347fc0
children
rev   line source
0
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
1
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
2 SSDT JIRA Plugin
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
3 ----------------
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
4
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
5 This project uses NetBeans with the Maven 2 plugin to build the project.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
6
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
7 Use the "package" goal to build the jar.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
8
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
9 The rest of this README is the default from the JIRA archetype.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
10
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
11 --------------------------------------------------------------
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
12
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
13
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
14
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
15 1. CUSTOMISE THE PLUGIN
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
16
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
17 - Run 'mvn eclipse:eclipse' to generate an Eclipse project file.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
18 - Edit pom.xml. Add information about your project, its developers and your organisation.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
19 - Add dependencies as necessary
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
20 - Edit the plugin descriptor, src/main/resources/atlassian-plugin.xml. Add or modify plugin modules in your project.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
21 - Edit the plugin code in src/main/java/ or the unit tests in src/test/java/.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
22
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
23 2. BUILD THE PLUGIN
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
24
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
25 Building with your plugin with Maven is really easy:
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
26
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
27 - Run 'mvn compile' to compile the plugin.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
28 - Run 'mvn test' to run the unit tests.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
29 - Run 'mvn integration-test' to run the integration tests.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
30 - Run 'mvn package' to produce the JAR.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
31
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
32 For the above commands to skip the various test phases add one of the following options to the command:
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
33
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
34 -Dmaven.test.skip=true - skips both unit and integration tests
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
35 -Dmaven.test.unit.skip=true - skips unit tests
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
36 -Dmaven.test.it.skip=true - skips integration tests
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
37
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
38 XML data that is usually imported into the JIRA instance by the tests should be placed in:
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
39
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
40 src/test/xml/ directory provided
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
41
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
42 Packages containing integration tests should start with it. For instance:
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
43 it.com.atlassian.jira.plugins.fisheye.TestSomething
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
44 it.com.atlassian.jira.plugins.calendar.TestSomethingElse
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
45
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
46 Hence these classes should go under src/test/java/it/directory
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
47
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
48 The following system properties are available to control the behaviour of the integration test harness:
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
49
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
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
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
51
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
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.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
53
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
54 jira.version - version of JIRA to compile and test against. default is 3.10.2
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
55
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
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.
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
57
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
58 jira.test-lib.version - version of jira-func-tests JAR to compile and test against. default is 3.10-DEV
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
59
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
60 http.port - port on which this instance of JIRA will be accessible on. Default: 8989
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
61
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
62 jira.url - base URL for this instance of JIRA. Default: http://localhost:{http.port}/jira/
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
63 rmi.port
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
64
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
65
92d945347fc0 V2 of the SSDT JIRA Plugins. Uses new Maven 2 based project. Created
smith
parents:
diff changeset
66 Please remove this file before releasing your plugin.