adoptium / adoptium-support

For end-user problems reported with our binary distributions
Apache License 2.0
46 stars 15 forks source link

jPackage documentation needs major update #431

Closed chjan closed 2 years ago

chjan commented 2 years ago

Summary

I am reporting on the latest version of the JDK, as of jan 18 2022. The documentation (we found only : https://docs.oracle.com/en/java/javase/16/jpackage/packaging-overview.html, with also this: https://docs.oracle.com/en/java/javase/17/jpackage/packaging-tool-user-guide.pdf), should be updated and proper advanced example (with rich commenting), should be added, because to use jpackage is not necessarily straight forward. To not become a time thief for more unexperienced developer, please note that whenever launching an application for MacOs, and when the application exploit system resources classified by Apple as "security" (e.g. microphone input), then the application MUST be packed and signed according to Apple rules. Therefore, I suggest the following:

No doubt, this manner of documentation is obscure at best. Please add a separate chapter in the official documentation on how to include non-java files in the final install directory, DLL files and whatever else imagineable. Preferrably, there should be a systemtic approach to this, like "put dll files in "external files" subdirectory", or something like that. That way, user not advocated in Groovy for Gradle can save time trying to program the correct subdir.

In concrete words: I want to expand the build.gradle files for the pure java application so as to make it installable on the three major desktop operating systems (while Andoid app has its own way, of course). Understand?

Beyond those comments, jpackage appears to be or become a very useful tool that allows for automatic cross-platform launch of applications. And this is precisely what I would like to see: Rich and somewhat complicate examples on how jpackage can be the tool to make things fully automated, including, but not limited to a list of relevant plugins, Gradle in my case. I am still not sure if I need the badass plugin for gradle, but it appears so. No documentation found.

Many thanks, looking forward to crawl my way to a fully automated system.

Steps to reproduce

Expected results

Actual results

Triaging info

Java version:

What is your operating system and platform?

How did you install Java?

Did it work before?

Did you test with other Java versions?

karianna commented 2 years ago

@chjan - This is a request that you should post upstream at openjdk.java.net. I'd recommend the core-libs mailing list