Lifecycle Mappings
The lifecycle mapping to use in a POM launching the IzPack Maven plugin depends on your needs.
In common, there are the following mappings are useful with izpack-maven-plugin:
- pom
This is a standard lifecycle mapping in Maven, intended for just grouping several submodules, but almost not doing any job. The izpack-maven-plugin must be explicitly launched in a phase of your choice. - izpack-jar
This is a new mapping coming with IzPack 5.0, reducing the complexity of a POM launching the izpack-maven-plugin.
It acts similar than behaves like the jar lifecycle mapping in Maven except it replaces that rather than launching the maven-jar-plugin in the phasepackageby launching package phase, it launches the izpack-maven-plugin, instead. This can be used as a snap-in for building installer jars instead of compiled jars from Java code, especially combined with the features for attaching an IzPack installer a direct or classified Maven artifact to the project.
The izpack-jar packaging type cannot be used in a module compiling Java source code into a Jar file, but is intended to be used in a standalone module just doing the job of assembling and building an installer. This increases the transparency of your project and using izpack-jar decreases the complexity of the POM.
| Info | ||
|---|---|---|
| ||
For the izpack-jar mapping is important to add the <extensions>true</extensions>. If you don't, Maven will not be able to see this as a valid packaging. See the example usage below. |
Configuration
...
| Configuration Attribute | Value Range | Default Value | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
baseDir | string | ${project.build.directory}/staging | Base directory of compilation process | ||||||||||
installFile | string | ${basedir}/src/main/izpack/install.xml | Location of the IzPack installation file. | ||||||||||
comprFormat | default | gz | bzip2 | xz | lzma | deflate |
| Optional compression format for single files defined in <packs>. All files in all packs except those explicitly marked as <pack200/> are automatically added compressed in the given format and uncompressed later when the installer starts. This may significantly decrease the installer size, but take some more time to compile the installer and install the files later. See also Compressing pack files for more information on this feature. Since: IzPack 5.1 (has been broken in 5.0) | ||||||||||
| comprLevel | integer -1, 0..9 | 9 | The compression level of the resulting installer jar file. This attribute has nothing in common with the compression attribute declared above, which defines compression for single files added in packs, but defines just the compression level of the whole installer jar file itself. | ||||||||||
outputDirectory | ${project.build.directory} | Target directory containing the compiled installer jar | |||||||||||
mkdirs | true | false | false | Whether to automatically create parent directories of the output file | ||||||||||
finalName | Name of the compiled installer jar | ||||||||||||
| classifier | Not set | Classifier to add to the artifact generated. If given, the artifact is attachable. Furthermore, the output file name gets -classifier as suffix. If this is not given,it will merely be written to the output directory according to the finalName. | |||||||||||
| enableAttachArtifact | true | false | true | Whether to attach the generated installer jar to the project as artifact if a classifier is specified. This has no effect if no classifier was specified.
| ||||||||||
|
|
|
Removed Since: IzPack 5.1.3. | ||||||||||
autoIncludeUrl | true | false | false | Whether to automatically include project.url from Maven into the IzPack info header | ||||||||||
autoIncludeDevelopers | true | false | false | Whether to automatically include developer list from Maven into IzPack info header | ||||||||||
kind | standard | web | standard | Resulting installer type |
...