Lifecycle Mappings
The lifecycle mapping to use in a POM launching the IzPack Maven plugin depends on your needs.
In common, there are useful the following mappings:
- pom
This is a standard lifecycle mapping in Maven, intended for just grouping several submodules, but almost not doing any jobs. The izpack-maven-plugin must be explicitely 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 the jar lifecycle mapping in Maven except it replaces launching the maven-jar-plugin in the phase package, but launching 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 making an IzPack instalelr a Maven artifact.
Configuration
Configuration Attribute | Value Range (Default) | Default Value | Description |
---|---|---|---|
baseDir | string | ${project.build.directory}/staging | Base directory of compilation process |
installFile | string | ${basedir}/src/main/izpack/install.xml | Target location of the compiled installer jar |
comprFormat | default | bzip2 | default | Target compression format of the compiled installer jar |
comprLevel | integer -1, 0..9 | -1 | Compression level of the compiled installer jar. Deactivated by default (-1) |
descriptorEncoding | |||
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 | ||
enableOverrideArtifact | |||
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 |
Example usage
Example usage of IzPack Maven Plugin
<plugin> <groupId>org.codehaus.izpack</groupId> <artifactId>izpack-maven-plugin</artifactId> <extensions>true</extensions> <configuration> <descriptorEncoding>UTF-8</descriptorEncoding> <baseDir>${staging.dir.app}</baseDir> <installFile>${izpack.dir.app}/install.xml</installFile> <outputDirectory>${project.build.directory}</outputDirectory> <finalName>${project.build.finalName}</finalName> <enableOverrideArtifact>true</enableOverrideArtifact> <mkdirs>true</mkdirs> <autoIncludeUrl>false</autoIncludeUrl> <autoIncludeDevelopers>false</autoIncludeDevelopers> </configuration> </plugin>