Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the readme with information on the JLink tasks #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the readme with information on the JLink tasks #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 26 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ plugins {

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)
Expand All @@ -40,10 +38,6 @@ jlink {
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")
}
}
}
Expand All @@ -53,7 +47,29 @@ See the [samples](samples) directory for more examples on the jlink plugin in ac

## Unavailable Options

`--disable-plugin pluginname`
`--limit-modules`
`--save-opts`
`@filename`
| Option | Reason |
|---|---|
`--disable-plugin pluginname` | All JLink plugins are available, though not necessarily used
`--limit-modules` | Only necessary modules are linked. This option may be enabled in a future release.
`--save-opts` | Options are stored in the build script!
`@filename` | Options are stored in the build script!

## JLink Tasks

| Task | Description |
|---|---|
`jlinkGenerate{configuration}` | Generates the JLink image for the given configuration name
`jlinkArchiveZip{configuration}` | Generates a `.zip` compressed archive containing the entire JLink image
`jlinkArchiveTar{configuration}` | Generates a `.tar` uncompressed archive containing the entire JLink image

`{configuration}` is generated based on the name of the configuration given in the build script.
If a configuration name is multiple words, each word will be capitalized and the whitespace removed
to create the name of the JLink task. In the example above, setting the configuration name to `"configuration name"`
will result in `jlinkGenerateConfigurationName` for the task to generate the JLink image for that
configuration, and `jlinkArchive[Zip|Tar]ConfigurationName` to create a zip or tar archive for that image.

Generated JLink images are created in `build/jlink/{configuration-name}`. The configuration name is exactly
as specified in the build script.

Generated archives are created in `build/distributions/{project-name}-{configuration}`, eg `example-project-release.zip`.