开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

JPackage Gradle Plugin

Gradle plugin for jpackage tool available since JDK-14.

Finding jpackage

Plugin searches for jpackage executable using the following priority list:

1. Configured toolchain

2. java.home system property.

Configuration

There are generic jpackage parameters as well as OS-specific parameters for OS X, Linux, Windows. OS-specific parameters are processed when build is done on the corresponding OS.

If some generic parameters should have different values based on OS then they should be placed into configuration blocks:

• windows
• mac
• linux

Example:

// Windows specific parameters will be processed only during Windows build
winMenu = true
winDirChooser = true

mac {
    // Generic parameter value for OS X build
    icon = "icons/icons.icns"
}

windows {
    // Generic parameter value for Windows build
    icon = "icons/icons.ico"
}

Parameters

^(*) - these parameters represent file or directory path and are resolved relative to the project root unless they contain an absolute path.

Image Type

Default Command-Line Arguments

Default command line arguments are passed to the main class when the application is started without providing arguments. Each argument should be specified using <argument> configuration parameter.

Example:

argumens = listOf(
    "SomeArgument",
    "Argument with spaces",
    "Argument with \"quotes\""
)

Additional Parameters

Additional parameters allow passing jpackage command line options not supported by the plugin. These parameters are passed as is without any transformation.

Example:

additionalParameters = listOf(
    "--jlink-options",
    "--bind-services"
)

Logging

Plugin uses LogLevel.INFO to print various information about toolchain, jpackage parameters, etc. Use gradle option --info to check this output.

Dry Run Mode

To execute plugin tasks in dry run mode without calling jpackage set propertyjpackage.dryRun to true.

Example:

$ ./gradlew clean build jpackage --info -Djpackage.dryRun=true

Examples

• Modular Application with Full Runtime
• Non-Modular Application

References

Packaging Tool User's Guide