IzPack Gradle plugin

The plugin provides a one-stop solution for packaging, distributing and deploying applications for the Java platform using IzPack.

Usage

To use the IzPack plugin, include in your build script:

plugins {
    id 'org.izpack.gradle' version '3.2.3'
}

The plugin JAR needs to be defined in the classpath of your build script. It is directly available on the Gradle plugin portal. The following code snippet shows a usage example:

buildscript {
    repositories {
        gradlePluginPortal()
    }

    dependencies {
        classpath 'org.izpack:izpack-gradle-plugin:3.2.3'
    }
}

apply plugin: 'org.izpack.gradle'

To define the IzPack standalone compiler dependency please use the izpack configuration name in your dependencies closure.

For IzPack v5

dependencies {
    izpack 'org.codehaus.izpack:izpack-ant:5.2.4'
}

or for IzPack v4

dependencies {
    izpack 'org.codehaus.izpack:izpack-standalone-compiler:4.3.5'
}

Tasks

The IzPack plugin defines the following tasks:

• izPackCreateInstaller: Creates an IzPack-based installer.

Convention properties

The IzPack plugin defines the following convention properties in the izpack closure:

• baseDir: The base directory of compilation process (defaults to build/assemble/izpack).
• installerType: The installer type (defaults to standard). You can select between standard and web.
• installFile: The location of the IzPack installation file (defaults to src/main/izpack/install.xml).
• outputFile: The installer output directory and filename (defaults to build/distributions/<projectname>-<version>-installer.jar).
• compression: The compression of the installation (defaults to default). You can select between default, deflate and raw.
• compressionLevel: The compression level of the installation (defaults to -1 for no compression). Valid values are -1 to 9.
• appProperties: The Map of application properties to be used for the compilation process (defaults to empty Map).

Example

izpack {
    baseDir = layout.buildDirectory.dir('assemble/izpack')
    installFile = file('installer/izpack/installer.xml')
    outputFile = layout.buildDirectory.file("distributions/griffon-${version}-installer.jar")
    compression = 'deflate'
    compressionLevel = 9
    appProperties = ['app.group': 'Griffon', 'app.name': 'griffon', 'app.title': 'Griffon',
                     'app.version': version, 'app.subpath': "Griffon-$version"]
}