https://github.com/bmuschko/gradle-izpack-plugin

Gradle plugin that provides support for packaging applications for the Java platform via IzPack.
https://github.com/bmuschko/gradle-izpack-plugin

gradle-plugin izpack packaging

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/bmuschko/gradle-izpack-plugin
• Owner: bmuschko
• License: apache-2.0
• Created: 2011-06-28T14:07:33.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T16:22:19.000Z (over 3 years ago)
• Last Synced: 2023-07-06T19:39:49.531Z (over 1 year ago)
• Topics: gradle-plugin, izpack, packaging
• Language: Groovy
• Homepage:
• Size: 324 KB
• Stars: 64
• Watchers: 8
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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](http://izpack.org/img-izpack/logo-medium.png)

    

        

            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.

        

    

    

        

            I am 

            actively looking for contributors 

            willing to take on maintenance and implementation of the project. If you are interested and would love to see this 

            plugin continue to thrive, shoot me a mail.

        

    

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

using [IzPack](http://izpack.org/).

## Usage

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

    plugins {

        id 'com.bmuschko.izpack' version '3.2'

    }

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'

        }

    }

    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](http://izpack.org/documentation/installation-files.html) (defaults to `src/main/izpack/install.xml`).

* `outputFile`: The installer output directory and filename (defaults to `build/distributions/--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"]

    }