README.md

simple-jlink

A simple Gradle plugin for generating native Java runtime images with the jlink tool introduced in Java 9. Your applications can be modular, unmodular, and use modular or unomdular libraries. The plugin will automatically determine which modules to include in the generated image.

Note: this plugin must be run on JDK 10 or higher. JDK 9 is not supported.

See the jlink Reference Page for details on the jlink tool and its options, most of which are exposed to plugin users.

plugins {
  application
  id("org.gradleweaver.plugins.jlink")
}

jlink {
  "configuration name" {
    applicationJar.set(provider { tasks.getByName<Jar>("jar").archivePath }) // No default value
    
    // jlink executable options. See the reference page for details
    bindServices.set(false)
    compressionLevel.set(JLinkTask.CompressionLevel.NONE)
    endianess.set(JLinkTask.Endianness.SYSTEM_DEFAULT)
    ignoreSigningInformation.set(false)
    excludeHeaderFiles.set(false)
    excludeManPages.set(false)
    stripDebug.set(false)
    optimizeClassForName.set(false)
    
    // Extra modules to link that are not discovered by jdeps
    extraModules.addAll("module1", "module2", ...)
    
    // Single method to exclude header files, man pages, and debug symbols
    // Also sets the compression level to ZIP (maximum)
    useMinimalImage()
    
    // Generate a launcher script
    launcher {
      launcherName.set("LauncherName")
      vmOptions.addAll("-Xms512m", "-Xmx4G")
      
      // Only required if the app and all its dependencies are modular
      applicationModuleName.set("com.example.app")
      mainClassName.set("com.example.app.Main")
    }
  }
}

See the samples directory for more examples on the jlink plugin in action.

Unavailable Options

--disable-plugin pluginname
--limit-modules
--save-opts
@filename