| Goal | Description |
|---|---|
| gump | -- The default goal. This goal simply executes the - gump:generate-descriptor goal - | -
| Goal | +Description | +
| gump:gump | +
+ Generates a
+ gump.xml file for Apache Gump
+ that is usable directly for the current project.
+ |
+
| gump:multiproject | +
+ Generates a
+ gump.xml file for Apache Gump
+ that is usable directly, aggregating all of your
+ modules into one file.
+ |
+
| gump | ++ The default goal. This is an alias for + gump:gump. + | +
| gump:generate-descriptor |
- Generates a gump.xml file for Apache Gump
- that is usable directly.
- + This is an alias for + gump:gump. |
-
This plug-in generates a descriptor that allows your project to - participate in Gump builds. The use for this descriptor will soon be - negated by the use of the Maven Reactor but until the Reactor is - complete the generation of the Gump descriptor is somewhat useful. + participate in Gump builds.
++ Generating the gump descriptor should require few modifications to your project. + The most important addition is that of the Gump repository ID to your project file. + This tells Gump where to checkout the source code from. For example: +
++ If you are building a descriptor for a single Maven project, run: +
++ If you are using a multiproject set up, and would like to aggregate all the projects into + a single descriptor, run: +
++ If you need to make any customisations to the output, see the "Dependencies and IDs" section that follows, + and the Properties Reference. + If the plugin does not support generating a structure that you need in the descriptor, please file an + enhancement request in JIRA. +
++ Ideally, the Maven project IDs should match those used by Gump - however this is not + always the case. For a list of known mismatches, see + The Gump Wiki. This page also explains + the differences between Gump and Maven IDs. +
+
+ Normally, the plugin will map the artifact ID of a dependency to the project name in Gump. The group ID is not
+ used. To force the plugin to match a certain Gump project, add the <gump.project>
+ dependency property. For example:
+
+ If you must also select a particular JAR id from Gump, you can add the <gump.id>
+ dependency property. For example:
+
depend project
- value for Gump.
+ The filename of the descriptor to generate. The default is ${basedir}/gump.xml.
<module/> element.
+ The default is the artifact ID of the project.
+