Add missing jpackage options #5227

StefanLobbenmeier · 2025-02-09T16:55:53Z

Describe proposed changes and the issue being fixed

Adds additional jpackage options, introduced in jdk 17 and 21:

--win-shortcut-prompt (from jdk 17)
--win-update-url (from jdk 17)
--linux-package-deps (from jdk 17) - (although I am unsure how to use that option, naming suggests an argument but there is no argument documented)
--mac-dmg-content (from jdk 21)

Fixes

Testing

Describe how you tested your changes. If possible and needed:

Test it on a sample project
Write unit tests
Provide a code snippet

This should be tested by QA

Release Notes

Fixes - Desktop

Added jpackage options --win-shortcut-prompt, --win-update-url, --linux-package-deps and --mac-dmg-content

StefanLobbenmeier · 2025-02-09T17:02:08Z

...ns/compose/src/main/kotlin/org/jetbrains/compose/desktop/application/dsl/PlatformSettings.kt

@@ -36,6 +36,8 @@ abstract class AbstractMacOSPlatformSettings : AbstractPlatformSettings() {
    var appCategory: String? = null
    var minimumSystemVersion: String? = null

+    var dmgContents = ArrayList<String>()


since this is supported from 21 onwards, I considered having this option opt-in to make sure people are aware that this only works when building with jdk 21

But possibly I am overthinking this, what do you think?

Is it possible to check the toolchain here, and issue a warning (and ignore the property) if current JDK is older than 21?

it probably is possible, but I would need a pointer to somewhere this has been done to make sure I get it right

I found if (jvmRuntimeInfo.majorVersion >= 18) { on my own 😄

StefanLobbenmeier · 2025-02-09T17:05:16Z

Not tested yet, only made sure to copy the values from documentation. Not sure how I can make a snapshot build from this to test in a sample projects. If there is an easy way to publish this as snapshot I have a sample repo to test these changes

kropp · 2025-02-14T10:18:05Z

Please add a reference to https://youtrack.jetbrains.com/issue/CMP-2236 in the PR description

kropp · 2025-02-14T10:24:07Z

I haven't used jpackage on Linux, but https://github.com/petr-panteleyev/jpackage-gradle-plugin/ suggests that the --linux-package-deps option might be boolean.
Could you please verify it and update documentation, or remove it until its meaning is clear.

kropp · 2025-02-14T10:14:50Z

...ns/compose/src/main/kotlin/org/jetbrains/compose/desktop/application/dsl/PlatformSettings.kt

@@ -36,6 +36,8 @@ abstract class AbstractMacOSPlatformSettings : AbstractPlatformSettings() {
    var appCategory: String? = null
    var minimumSystemVersion: String? = null

+    var dmgContents = ArrayList<String>()


Is it possible to check the toolchain here, and issue a warning (and ignore the property) if current JDK is older than 21?

StefanLobbenmeier · 2025-02-14T14:20:52Z

I agree, the documentation is bad there. I just spun up an ubuntu docker container to check this.

I could confirm that the option accepts parameters and those affect the output .deb:

This is the .deb I got with this jpackage command: jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar --linux-package-deps ffmpeg

dpkg -I yt-dlp-compose_1.0_arm64-ffmpeg-dep.deb
 new Debian package, version 2.0.
 size 37176504 bytes: control archive=1127 bytes.
     531 bytes,    11 lines      control
     867 bytes,    38 lines   *  postinst             #!/bin/sh
     819 bytes,    31 lines   *  postrm               #!/bin/sh
     631 bytes,    35 lines   *  preinst              #!/bin/sh
     789 bytes,    39 lines   *  prerm                #!/bin/sh
 Package: yt-dlp-compose
 Version: 1.0
 Section: misc
 Maintainer: Unknown <Unknown>
 Priority: optional
 Architecture: arm64
 Provides: yt-dlp-compose
 Description: yt-dlp-compose
 Depends: libasound2t64, libbrotli1, libbsd0, libbz2-1.0, libc6, libfreetype6, libgcc-s1, libgif7, libglib2.0-0t64, libgraphite2-3, libharfbuzz0b, libjpeg-turbo8, liblcms2-2, libmd0, libpcre2-8-0, libpcsclit
e1, libpng16-16t64, libstdc++6, libx11-6, libxau6, libxcb1, libxdmcp6, libxext6, libxi6, libxrender1, libxtst6, zlib1g , ffmpeg
 Installed-Size: 160957

While the .deb without dependencies does not have this dependency (jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar):

dpkg -I yt-dlp-compose_1.0_arm64-without-deps.deb
 new Debian package, version 2.0.
 size 37177420 bytes: control archive=1122 bytes.
     523 bytes,    11 lines      control
     867 bytes,    38 lines   *  postinst             #!/bin/sh
     819 bytes,    31 lines   *  postrm               #!/bin/sh
     631 bytes,    35 lines   *  preinst              #!/bin/sh
     789 bytes,    39 lines   *  prerm                #!/bin/sh
 Package: yt-dlp-compose
 Version: 1.0
 Section: misc
 Maintainer: Unknown <Unknown>
 Priority: optional
 Architecture: arm64
 Provides: yt-dlp-compose
 Description: yt-dlp-compose
 Depends: libasound2t64, libbrotli1, libbsd0, libbz2-1.0, libc6, libfreetype6, libgcc-s1, libgif7, libglib2.0-0t64, libgraphite2-3, libharfbuzz0b, libjpeg-turbo8, liblcms2-2, libmd0, libpcre2-8-0, libpcsclite1, libpng16-16t64, libstdc++6, libx11-6, libxau6, libxcb1, libxdmcp6, libxext6, libxi6, libxrender1, libxtst6, zlib1g
 Installed-Size: 161654

Somewhat incomplete history of commands in case you want to reproduce (missing apt install openjdk tmux, but this will depend on the image)

    1  git clone https://github.com/StefanLobbenmeier/yt-dlp-compose.git
    2  apt install git
    3  git clone https://github.com/StefanLobbenmeier/yt-dlp-compose.git
    4  cd yt-dlp-compose/
    5  ./gradlew assemble
    6  ls
    7  ls build
    8  ls build/libs/
    9  ls build/libs/yt-dlp-compose-1.0.0.jar
   10  jpackage build/libs/yt-dlp-compose-1.0.0.jar
   11  jpackage --type jlink --name yt-dlp-compose --main-jar build/libs/yt-dlp-compose-1.0.0.jar
   12  jpackage --type jlink --name yt-dlp-compose --main-jar build/libs/yt-dlp-compose-1.0.0.jar --input build/libs
   13  apt search jlink
   14  jpackage --type deb --name yt-dlp-compose --main-jar build/libs/yt-dlp-compose-1.0.0.jar --input build/libs
   15  jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar
   16  apt install fakeroot
   17  jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar
   18  apt install objcopy
   19  apt search objcopy
   20  apt install binutils
   21  jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar
   22  ls
   23  mv yt-dlp-compose_1.0_arm64.deb yt-dlp-compose_1.0_arm64-without-deps.deb
   24  jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar --linux-package-deps openjdk-21-jdk
   25  mv yt-dlp-compose_1.0_arm64.deb yt-dlp-compose_1.0_arm64-openjdk-dep.deb
   26  jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar --linux-package-deps ffmpeg
   27  dpkg -I package.deb
   28  dpkg -I yt-dlp-compose_1.0_arm64-openjdk-dep.deb
   29  mv yt-dlp-compose_1.0_arm64.deb yt-dlp-compose_1.0_arm64-ffmpeg-dep.deb
   30  dpkg -I yt-dlp-compose_1.0_arm64-ffmpeg-dep.deb
   31  history

StefanLobbenmeier · 2025-02-14T14:24:18Z

Just some more tests, you can add multiple dependencies separated by comma: --linux-package-deps "foo, bar"

Depends: libasound2t64, libbrotli1, libbsd0, libbz2-1.0, libc6, libfreetype6, libgcc-s1, libgif7, libglib2.0-0t64, libgraphite2-3, libharfbuzz0b, libjpeg-turbo8, liblcms2-2, libmd0, libpcre2-8-0, libpcsclite1, libpng16-16t64, libstdc++6, libx11-6, libxau6, libxcb1, libxdmcp6, libxext6, libxi6, libxrender1, libxtst6, zlib1g , foo, bar

And just putting it there without arguments does not add any binaries:

jpackage --type deb --name yt-dlp-compose --input build/libs --main-jar yt-dlp-compose-1.0.0.jar --linux-package-deps

Depends: libasound2t64, libbrotli1, libbsd0, libbz2-1.0, libc6, libfreetype6, libgcc-s1, libgif7, libglib2.0-0t64, libgraphite2-3, libharfbuzz0b, libjpeg-turbo8, liblcms2-2, libmd0, libpcre2-8-0, libpcsclit
e1, libpng16-16t64, libstdc++6, libx11-6, libxau6, libxcb1, libxdmcp6, libxext6, libxi6, libxrender1, libxtst6, zlib1g

But this only works when its the last argument, otherwise it consumes the next one:

jpackage --type deb --name yt-dlp-compose --input build/libs --linux-package-deps --main-jar yt-dlp-compose-1.0.0.jar
Error: Invalid Option: [yt-dlp-compose-1.0.0.jar]

StefanLobbenmeier · 2025-02-14T14:41:09Z

One more evidence that behaviour is different from documentation - this is the definition of the argument in code, its a string argument:

https://github.com/openjdk/jdk/blob/fea5f2b1458cdd53f437e59caaffaa6e22fb59a7/src/jdk.jpackage/linux/classes/jdk/jpackage/internal/LinuxPackageBundler.java#L366-L372

…ike --linux-package-deps, so accept any string for now

StefanLobbenmeier added 4 commits February 9, 2025 17:36

Add --win-shortcut-prompt

fa59c83

Add --win-update-url

9c37dfe

Add --linux-package-deps

bc24f12

Add --mac-dmg-content

982604e

StefanLobbenmeier commented Feb 9, 2025

View reviewed changes

StefanLobbenmeier marked this pull request as ready for review February 9, 2025 17:02

StefanLobbenmeier changed the title ~~Add missing jpackage options, fix cmp 7580~~ Add missing jpackage options Feb 9, 2025

MatkovIvan requested a review from kropp February 14, 2025 09:05

kropp requested changes Feb 14, 2025

View reviewed changes

StefanLobbenmeier mentioned this pull request Feb 14, 2025

Correct documentation for --linux-package-deps openjdk/jdk#23638

Open

3 tasks

StefanLobbenmeier added 3 commits February 14, 2025 16:27

Check jvm major version before adding --mac-dmg-content cli arg

06768de

Actually --mac-dmg-content is supposed to be a comma separated list l…

b646e87

…ike --linux-package-deps, so accept any string for now

Add warning when --mac-dmg-content is used on unsupported jdk version

7a8fecb

StefanLobbenmeier requested a review from kropp February 14, 2025 15:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add missing jpackage options #5227

Add missing jpackage options #5227

StefanLobbenmeier commented Feb 9, 2025 •

edited

Loading

StefanLobbenmeier Feb 9, 2025

kropp Feb 14, 2025

StefanLobbenmeier Feb 14, 2025

StefanLobbenmeier Feb 14, 2025

StefanLobbenmeier commented Feb 9, 2025

kropp commented Feb 14, 2025

kropp commented Feb 14, 2025

kropp Feb 14, 2025

StefanLobbenmeier commented Feb 14, 2025

StefanLobbenmeier commented Feb 14, 2025

StefanLobbenmeier commented Feb 14, 2025

Add missing jpackage options #5227

Are you sure you want to change the base?

Add missing jpackage options #5227

Conversation

StefanLobbenmeier commented Feb 9, 2025 • edited Loading

Testing

Release Notes

Fixes - Desktop

StefanLobbenmeier Feb 9, 2025

Choose a reason for hiding this comment

kropp Feb 14, 2025

Choose a reason for hiding this comment

StefanLobbenmeier Feb 14, 2025

Choose a reason for hiding this comment

StefanLobbenmeier Feb 14, 2025

Choose a reason for hiding this comment

StefanLobbenmeier commented Feb 9, 2025

kropp commented Feb 14, 2025

kropp commented Feb 14, 2025

kropp Feb 14, 2025

Choose a reason for hiding this comment

StefanLobbenmeier commented Feb 14, 2025

StefanLobbenmeier commented Feb 14, 2025

StefanLobbenmeier commented Feb 14, 2025

StefanLobbenmeier commented Feb 9, 2025 •

edited

Loading