gradle-izpack-plugin

KO | EN

gitlite — search

#nodejs #python #javascript #docker #bot #java #shell #php #cli #github #compiler #elasticsearch

gradle-izpack-plugin

★ 66 Open GitHub ↗

Gradle plugin that provides support for packaging applications for the Java platform via IzPack.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Gradle IzPack plugin [![Build [Linux]](https://github.com/bmuschko/gradle-izpack-plugin/actions/workflows/linux-build.yaml/badge.svg)](https://github.com/bmuschko/gradle-izpack-plugin/actions/workflows/linux-build.yaml)

![IzPack Logo](https://izpack.org/img-izpack/logo-medium.png)

<table style="border: 1px solid">
    <tr>
        <td>
            Over the past couple of years this plugin has seen many releases. Thanks to everyone involved! 
            Unfortunately, I don't have much time to contribute anymore. In practice this means far less activity, 
            responsiveness on issues and new releases from my end.
        </td>
    </tr>
    <tr style="background-color: #F0F0F01C">
        <td>
            The plugin is now maintained by <a href="https://izpack.org/">IzPack</a> under the <a href="https://github.com/izpack/izpack-gradle-plugin">izpack-gradle-plugin</a> project.
        </td>
    </tr>
</table>

The plugin provides a one-stop solution for packaging, distributing and deploying applications for the Java platform
using [IzPack](https://izpack.org/).

## Usage

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

plugins {
        id 'com.bmuschko.izpack' version '3.2.1'
    }

The plugin JAR needs to be defined in the classpath of your build script. It is directly available on the
[Gradle plugin portal](https://plugins.gradle.org/plugin/com.bmuschko.izpack). The following code snippet shows a usage example:

buildscript {
        repositories {
            gradlePluginPortal()
        }

dependencies {
            classpath 'com.bmuschko:gradle-izpack-plugin:3.2.1'
        }
    }

apply plugin: 'com.bmuschko.izpack'

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.1.3'
    }

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](https://izpack.atlassian.net/wiki/spaces/IZPACK/pages/491709/Writing+Installation+Descriptions) (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 = file("$buildDir/assemble/izpack")
        installFile = file('installer/izpack/installer.xml')
        outputFile = file("$buildDir/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"]
    }

gradle-izpack-plugin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README