You can execute the install4j compiler from gradle with the install4j Gradle plugin. To make the Gradle plugin available to your build script, you have to apply the install4j Gradle plugin:

plugins {
    id "com.install4j.gradle" version "X.Y.Z"
}

If you do not want to use the Gradle plugin repository for this purpose, the Gradle plugin is distributed in the file bin/gradle.jar.

The plugin has two parts: The global configuration with the top-level install4j {...} configuration block and tasks of type com.install4j.gradle.Install4jTask.

The global configuration block can specify defaults for task properties that are applied to all install4j tasks, for example, the optional install4j installation directory, if no auto-provisioning is desired:

install4j {
    installDir = file("/path/to/install4j_home")
}

Task parameters

The install4j task supports the following parameters, many of which are explained in greater detail for the command line compiler.

The "Global" column shows if a parameter can also be specified in the global install4j {...} configuration block. Definitions in the task override global definitions.

Examples

Simple example:

install4j {
    installDir = file("/opt/install4j")
}
task media(type: com.install4j.gradle.Install4jTask) {
    projectFile = file("myProject.install4j")
}

More complex example:

if (!hasProperty("install4jHomeDir")) {
    File propertiesFile = file("${System.getProperty("user.home")}/.gradle/gradle.properties")
    throw new RuntimeException("Specify install4jHomeDir in $propertiesFile")
}

boolean dev = hasProperty("dev")

install4j {
    installDir = file(install4jHomeDir)
    faster = dev
    disableSigning = dev
    winKeystorePassword = "supersecretWin"
    macKeystorePassword = "supersecretMac"

    if (dev) {
        mediaTypes = ["windows"]
    }
}

task media(type: com.install4j.gradle.Install4jTask) {
    dependsOn "dist" // example task that prepares the distribution for install4j

    projectFile = "myProject.install4j"
    variables = [majorVersion: version.substring(0, 1), build: 1234]
    variableFiles = ["var1.txt", "var2.txt"]
}

The "hello" sample project includes a Gradle build script that shows how to set up the install4j task. To install the sample projects, invoke Project→Open Sample Project from the install4j IDE. When you do this for the first time, the sample projects are copied to the "Documents" folder in your home directory.

In the samples/hello directory, execute

gradle media

to start the build. If you have not defined install4jHomeDir in gradle.properties next to build.gradle, the build will fail with a corresponding error message.

Configuration cache

By default, the install4j tasks in the install4j Gradle plugin are never up to date and will run on every execution. This is because the task would have to perform a dry run to get a list of input files.

However, once you add file inputs to the install4j task, regular up-to-date checking will be done. File inputs are specified with method calls on the inputs property of a task:

task media(type: com.install4j.gradle.Install4jTask) {
  inputs.dir(stagingDir)
  inputs.files(file1, file2)
  ...
}

Then the task will be up to date if the inputs of its properties and your custom inputs are up to date with respect to the last task execution. In this way you can use the Gradle configuration cache which is otherwise supported by the install4j task.

Creating JRE bundles

To create a JRE bundle from your Gradle build script, use the com.install4j.gradle.CreateBundleTask and and set its javaHome property to the JRE that you want to create a bundle for.

The CreateBundleTask invokes the createbundle command line executable in the install4j installation and has the following properties:

Example:

task createBundle(type: com.install4j.gradle.CreateBundleTask) {
    javaHome = "/usr/lib/jvm/jre-11/jre"
    outputDirectory = "/home/build/projects/myProject/jreBundles"
    version = "11"
    id="j3d"
    jmodDirs = ["jmods"]
    jmodFiles = ["one.jmod", "two.jmod"]
}