Describe relation to jlink

[koppor]

I did not found information in the README.md how this plugin relates to jlink.

We pass some custom parameters to jlink -- https://github.com/JabRef/jabref/blob/fef855aadea92292cab8ee7605626f818bd5fa23/jabgui/build.gradle.kts#L228

I think, the other jlink parameters are not needed as we do not need to merge modules (hopefully)

We do, however, need some OS-specific jpackage configuration: https://github.com/JabRef/jabref/blob/fef855aadea92292cab8ee7605626f818bd5fa23/jabgui/build.gradle.kts#L324

[jjohannes]

Apologies for the currently very thin documentation. There are several points:

The plugin calls jpackage in two steps:

1. Build --type app-image - a os-independent image folder. This is where jlink is involved.
2. Build OS-specific package --type <package-type> - this may be called several times for the same target (e.g. exe and msi on Windows)

OS-independent options can be configured through the extension when you define a target:

java-module-packaging/src/main/java/org/gradlex/javamodule/packaging/JavaModulePackagingExtension.java

Lines 69 to 75 in b48122e

	abstract public Property<String> getApplicationName();
	abstract public Property<String> getApplicationVersion();
	abstract public Property<String> getApplicationDescription();
	abstract public Property<String> getVendor();
	abstract public Property<String> getCopyright();
	abstract public DirectoryProperty getJpackageResources();
	abstract public ConfigurableFileCollection getResources();

Many of them have defaults derived from Gradle (project name, version, ...).

The OS-specific things can be defined inside a target:

java-module-packaging/src/main/java/org/gradlex/javamodule/packaging/model/Target.java

Line 32 in 22c5b12

abstract public ListProperty<String> getOptions();

    target("windows") {
        packageTypes = listOf("msi")
        options = listOf(
                "--win-dir-chooser",
                "--win-menu",
                "--win-shortcut"
        )
    }

The --jlink-options would need to go into the first step. And we are indeed missing this. I'll add that (#59).

[jjohannes]

Preview for improvements available in: https://github.com/gradlex-org/java-module-packaging/tree/preview

[koppor]

Maybe, it would be good to add the explanation from #54 (comment) to the README.md?