Switch the Gradle build to org.gradlex.java-module plugins #13401

koppor · 2025-06-24T15:14:46Z

Follow-up to #13324

TODOs

portable build
- Is it just jabgui\build\tmp\jpackage\windows-2022\app-image\?
- Some comments at Explore switching the Gradle build to org.gradlex.java-module plugins #13324
Optional: signing by the gradle plugin (refs Explore switching the Gradle build to org.gradlex.java-module plugins #13324)
Optional: mac build for JabKit
Execution failed for task ':jabkit:jpackageMacos-14'.
> java.lang.NullPointerException (no error message)
Optional: As far as I understand, we can move directories buildres/* to src/main/resourcesPackage. But there needs more to be adapted in javaModulePackaging {
Optional: bring back JavaFX EA builds

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
[/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
[/] Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
[/] Screenshots added in PR description (if change is visible to the user)
[/] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
[/] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

…#13324) Co-authored-by: Oliver Kopp <kopp.dev@gmail.com> Co-authored-by: Siedlerchr <siedlerkiller@gmail.com>

...and remove some special case handling of MacOS

jjohannes · 2025-06-27T21:27:07Z

Sorry about the confusion with the portable version. This is indeed another use case not yet covered by the packaging plugin. But it is easy enough to add (gradlex-org/java-module-packaging#60). I made the change on the preview branch of the plugin we currently use in this PR.

What we have now is: binaries are building, including mac signing, through Gradle. I made some changes to binaries.yml to do the Mac build similar to the others. I am not sure if that is all correct. Please check and please test the results.

There are two follow up questions:

The mac command line build contained a few --java-options for jabgui. I did not find them in the Gradle build of jabgui, but found some similar options in the build for jabkit. It does not look like this discrepancy is on purpose. (Maybe something was lost with the Gradle changes already merged?). In any case, I added all the options to jabkit/build.gradle.kts which means they are applied to all targets (not only macos). Please verify if this is correct.
The current portable version contains two scripts in bin: This is not a jlink feature, but a feature of the jlink plugin - LaunchScriptGenerator.groovy. Are these just there, because the plugin adds them or are they actually used/expected by users? If yes, I can add the behavior of generating these scripts directly to the build. I can do that, I just want to clarify first if it is needed.

Optional: As far as I understand, we can move directories buildres/* to src/main/resourcesPackage.

Yes that is the plugins default. if you do that you can remove these configuration lines:
jpackageResources = layout.projectDirectory.dir("buildres")
But that is a detail which I would do in a follow up if you want. You can also keep it as it is.

bring back JavaFX EA builds

Is there any other specific need for these that breaks with this change? Or can we do the same adjustments that were done to binaries.yml once that is working? In any case, if you can live without the EA builds for some time, you could probably do the update in a follow up PR to speed things up.

@koppor please take another look at this once you find the time and let me know if there is something still missing or is broken. I would like to make sure that we have everything we need in the packaging plugin before I prepare the next release.

...to not produce artifacts - like zipped Jar-based distribution - we do not need.

koppor · 2025-06-29T22:45:06Z

Optional: As far as I understand, we can move directories buildres/* to src/main/resourcesPackage.
Yes that is the plugins default. if you do that you can remove these configuration lines: jpackageResources = layout.projectDirectory.dir("buildres")

Nice!

But that is a detail which I would do in a follow up if you want. You can also keep it as it is.

+1 for a follow-up PR.

bring back JavaFX EA builds
Is there any other specific need for these that breaks with this change?

No. We need to merge the EA workflow in this one - to avoid code duplication.

Will be a block of fetching the JavaFX version and changing the JavaFX version in the versions build gradle file.

Or can we do the same adjustments that were done to binaries.yml once that is working?

Yes

In any case, if you can live without the EA builds for some time,

Yes (therefore also flagged as "Optional" :))

koppor · 2025-06-29T23:24:03Z

jabkit is CLI only. As far as I understood, dmg does not make sense here. Thus, I remove it directly after it was created. I also added file renaming for jabkit to be in line with JabRef (GU).

Need to check after everything was build and uploaded to https://builds.jabref.org/pull/13401/merge

koppor · 2025-06-30T13:21:34Z

With fix gradlex-org/java-module-packaging#61 it works (on Windows)

Open points - can be fixed in a follow up

Too many Java binaries

Do we really need javac.exe distributed?

 Directory of C:\git-repositories\JabRef\jabkit\build\packages\windows-latest\jabkit\runtime\bin

30.06.2025  14:18            47.280 jabswitch.exe
30.06.2025  14:18           109.224 jaccessinspector.exe
30.06.2025  14:18            73.064 jaccesswalker.exe
30.06.2025  14:18            25.600 jar.exe
30.06.2025  14:18            25.600 jarsigner.exe
30.06.2025  14:18            51.928 java.exe
30.06.2025  14:18            25.600 javac.exe
30.06.2025  14:18            25.600 javadoc.exe
30.06.2025  14:18            25.600 javap.exe
30.06.2025  14:18            51.928 javaw.exe
30.06.2025  14:18            25.600 jdb.exe
30.06.2025  14:18            25.600 jdeprscan.exe
30.06.2025  14:18            25.600 jdeps.exe
30.06.2025  14:18            25.600 jfr.exe
30.06.2025  14:18            25.600 jimage.exe
30.06.2025  14:18            25.600 jlink.exe
30.06.2025  14:18            25.600 jmod.exe
30.06.2025  14:18            25.600 jnativescan.exe
30.06.2025  14:18            25.600 jpackage.exe
30.06.2025  14:18            25.600 jrunscript.exe
30.06.2025  14:18            25.600 jshell.exe
30.06.2025  14:18            25.600 jstatd.exe
30.06.2025  14:18            25.600 keytool.exe
30.06.2025  14:18            25.600 kinit.exe
30.06.2025  14:18            25.600 klist.exe
30.06.2025  14:18            25.600 ktab.exe
30.06.2025  14:18            25.600 rmiregistry.exe
30.06.2025  14:18            25.600 serialver.exe
              28 File(s)        922.224 bytes

JabRef (GUI)

✅ Portable application starts.

I cannot do --help.

Error: Option [--win-console] is not valid with type [msi]

This existed before, too.

trag-bot · 2025-06-30T14:28:21Z

@trag-bot didn't find any issues in the code! ✅✨

github-actions · 2025-06-30T14:41:28Z

The build of this PR is available at https://builds.jabref.org/pull/13401/merge.

InAnYan · 2025-06-30T14:59:35Z

Tested on Arch Linux: downloaded build tarball for portable JabRef and run bin/JabRef

Seems to work fine

calixtus · 2025-06-30T18:50:34Z

jablib/src/main/java/org/jabref/logic/preferences/PreviewPreferences.java

What happend here? On purpose or artifact?

ThiloteE · 2025-06-30T18:52:52Z

At https://builds.jabref.org/pull/13401/merge, jabkit and the portable versions do not have the number 6.0 in their name. Is this intentional?

ThiloteE · 2025-06-30T19:54:31Z

Tested:

Linux Mint 22.1 Cinnamon

Linux kernel 6.8.0-62-generic
cinnamon-version 6.4.8
✅ JabRef-portable_linux.tar.gz via /bin/JabRef. Seems to work fine.
JabRef_6.0.deb (maybe somebody can test this with a vagrant virtual machine?)

Explore switching the Gradle build to org.gradlex.java-module plugins (…

d648820

…#13324) Co-authored-by: Oliver Kopp <kopp.dev@gmail.com> Co-authored-by: Siedlerchr <siedlerkiller@gmail.com>

koppor added the dev: binaries Binary builds should be uploaded to builds.jabref.org label Jun 24, 2025

Enable gradle configuration caching

a74df8d

koppor changed the title ~~Switching the Gradle build to org.gradlex.java-module plugins~~ Switch the Gradle build to org.gradlex.java-module plugins Jun 24, 2025

koppor and others added 4 commits June 24, 2025 17:28

Update gradle.properties

6d5d992

Also build the portable version for all targets (app-image)

7400e80

Also build 'pkg' ony MacOS

a7c5a1c

Continue to change 'binaries' job to use 'packages' folder...

436e2f4

...and remove some special case handling of MacOS

jjohannes mentioned this pull request Jun 27, 2025

Support 'app-image' as package type gradlex-org/java-module-packaging#60

Open

jjohannes added 7 commits June 27, 2025 16:55

Add newline (checkstyle)

c8c76cb

Fix binaries.yml (1)

54d3c70

Fix binaries.yml (2)

a5aa239

Fix binaries.yml (3)

a8c7a98

Fix binaries.yml (4)

97741fe

Fix binaries.yml (5)

fe66df1

Configure signing for Mac targets

7caaf76

jjohannes added 3 commits June 28, 2025 17:01

Move java options into Gradle build

91bdb09

Remove unnecessary 'assemble' step

7f0878d

...to not produce artifacts - like zipped Jar-based distribution - we do not need.

macos -> macOS

141c4c9

koppor added 3 commits June 30, 2025 01:17

Fix filename(s) for JabKit

d2231d5

Remove obsolete renaming for portable

7e0fdfc

Remove jabkit DMG

b4f2fb7

koppor added 5 commits June 30, 2025 12:05

Fix PIT for removal of jabkit dmg

399ab22

Fix removal of DMG

f18a281

Also remove .sha256

1a73456

Try NOT to build dmg and pkg

6cce46b

Try "--win-console"

97dc2bd

Switch to fix

289ce0b

koppor added 2 commits June 30, 2025 16:01

Adapt to new "appImageOptions"

4f39601

Port changes to jabsrv-cli, too

4ace5e1

koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jun 30, 2025

koppor added 2 commits June 30, 2025 16:24

Merge branch 'main' into java-module-plugins

d00bd68

Merge branch 'main' into java-module-plugins

d345e53

calixtus reviewed Jun 30, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/preferences/PreviewPreferences.java

Copy link

Member

calixtus Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happend here? On purpose or artifact?

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Switch the Gradle build to org.gradlex.java-module plugins #13401

Switch the Gradle build to org.gradlex.java-module plugins #13401

koppor commented Jun 24, 2025 •

edited by jjohannes

Loading

Uh oh!

jjohannes commented Jun 27, 2025

Uh oh!

koppor commented Jun 29, 2025

Uh oh!

koppor commented Jun 29, 2025

Uh oh!

koppor commented Jun 30, 2025

Uh oh!

trag-bot bot commented Jun 30, 2025

Uh oh!

github-actions bot commented Jun 30, 2025

Uh oh!

InAnYan commented Jun 30, 2025

Uh oh!

calixtus Jun 30, 2025

Uh oh!

ThiloteE commented Jun 30, 2025

Uh oh!

ThiloteE commented Jun 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Switch the Gradle build to org.gradlex.java-module plugins #13401

Are you sure you want to change the base?

Switch the Gradle build to org.gradlex.java-module plugins #13401

Conversation

koppor commented Jun 24, 2025 • edited by jjohannes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODOs

Mandatory checks

Uh oh!

jjohannes commented Jun 27, 2025

Uh oh!

koppor commented Jun 29, 2025

Uh oh!

koppor commented Jun 29, 2025

Uh oh!

koppor commented Jun 30, 2025

Too many Java binaries

JabRef (GUI)

Uh oh!

trag-bot bot commented Jun 30, 2025

Uh oh!

github-actions bot commented Jun 30, 2025

Uh oh!

InAnYan commented Jun 30, 2025

Uh oh!

calixtus Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

ThiloteE commented Jun 30, 2025

Uh oh!

ThiloteE commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tested:

Linux Mint 22.1 Cinnamon

Uh oh!

Uh oh!

koppor commented Jun 24, 2025 •

edited by jjohannes

Loading

ThiloteE commented Jun 30, 2025 •

edited

Loading