Add arm 64 linux runner by Siedlerchr · Pull Request #13258 · JabRef/jabref

Siedlerchr · 2025-06-04T18:51:37Z

https://github.com/actions/partner-runner-images/blob/main/images/arm-ubuntu-22-image.md

In about one to three sentences, describe the changes you have made: what, where, why, ...

Steps to test

Describe how reviewers can test this fix/feature. Ideally, think of how you would guide a beginner user of Jabef to try out your change.
You can add screenshots or videos (using Loom or by just adding .mp4 files).

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.

Fixes #10842 https://github.com/actions/partner-runner-images/blob/main/images/arm-ubuntu-22-image.md

Siedlerchr · 2025-06-04T19:28:04Z

Still some issues with the module exporting:

The correct architecture should be picked because the architecture check print gives the right infomration

Using aarch66

The input changes require a full rebuild for incremental task ':jabgui:compileJava'.
Compilation mode: default, forking compiler
Full recompilation is required because no incremental change information is available. This is usually caused by clean builds or changing compiler arguments.
Compiling with toolchain '/home/runner/.gradle/jdks/azul_systems__inc_-24-aarch64-linux.2'.
Compiling with JDK Java compiler API.

/home/runner/work/jabref/jabref/jabgui/src/main/java/org/jabref/gui/actions/ActionFactory.java:20: error: package com.sun.javafx.scene.control is not visible
import com.sun.javafx.scene.control.ContextMenuContent;
                           ^
  (package com.sun.javafx.scene.control is declared in module javafx.controls, which does not export it to module org.jabref)
/home/runner/work/jabref/jabref/jabgui/src/main/java/org/jabref/gui/fieldeditors/contextmenu/EditorContextAction.java:19: error: package com.sun.javafx.scene.control is not visible
import com.sun.javafx.scene.control.Properties;
> Task :jabgui:compileJava FAILED
                           ^
gradle/actions: Writing build results to /home/runner/work/_temp/.gradle-actions/build-results/__run_3-1749064857597.json
  (package com.sun.javafx.scene.control is declared in module javafx.controls, which does not export it to module org.jabref)
2 errors


* What went wrong:
Execution failed for task ':jabgui:compileJava'.
> Compilation failed; see the compiler output below.
  /home/runner/work/jabref/jabref/jabgui/src/main/java/org/jabref/gui/actions/ActionFactory.java:20: error: package com.sun.javafx.scene.control is not visible
  import com.sun.javafx.scene.control.ContextMenuContent;
                             ^
    (package com.sun.javafx.scene.control is declared in module javafx.controls, which does not export it to module org.jabref)
  2 errors

Siedlerchr · 2025-06-04T19:45:53Z

@jjohannes Sorry to bother you again, but do you have any idea why the arm build is failing. Am I missing something? I just added a new target for arm in the conventions gradle. Locally on my computer I see that the task is registered.

jjohannes · 2025-06-04T20:36:16Z

@Siedlerchr your change is correct. It should not lead to compile failing. If I test this locally – by manually switching to the new target – the compilation works with the linux-aarch64 Jar.

The error indicates that it uses the original Jar and not the transformed one (of javafx.controls). But it should use the transformed one ans it does in my local test.

One idea: There are sometimes timing problems with the transformation mechanisms if other plugins access things too eagerly. Maybe something like this is happening. Maybe it does not work 100% well together with org.beryx.jlink. But we would have to analyze this more closely. (When I find the time soonish, I will have a look).
For reference: gradlex-org/extra-java-module-info#106 (and other issues linked from there).

For now, maybe it helps just rerunning the build. The only thing that is different in the target is that it is completely new and the Jars have never been downloaded/cached before. Although I don't understand why the other things work well in the GH context where things may always be rebuilt...

A temporary remedy could also be to first run a ./gradlew assemble before running the :jabgui:prepareModulesDir in a second step afterwards (in which mosts tasks will be UP-TO-DATE).

koppor · 2025-06-05T01:40:06Z


 // Source: https://github.com/jjohannes/java-module-system/blob/main/gradle/plugins/src/main/kotlin/targets.gradle.kts
-// Configure variants for OS
+// Configure variants for OS. target name can be any just must


The added sentence seems to be incomplete?

….gradle.kts Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

koppor · 2025-06-07T18:06:35Z

   (package com.sun.javafx.scene.control is declared in module javafx.controls, which does not export it to module org.jabref)
/home/runner/work/jabref/jabref/jabgui/src/main/java/org/jabref/gui/fieldeditors/contextmenu/EditorContextAction.java:19: error: package com.sun.javafx.scene.control is not visible
import com.sun.javafx.scene.control.Properties;

But we patch it in build-logic\bin\main\buildlogic.java-common-conventions.gradle.kts

Thus, it seems an issue with https://github.com/gradlex-org/extra-java-module-info, isn't it @jjohannes ?

jjohannes · 2025-06-07T19:11:41Z

@koppor it looks like the compiler is not using the transformed Jar. But I cannot reproduce the issue. If I manually set the target to ubuntu-22.04-arm on my machine here, ./gradlew assemble works.

Additionally: - Fix LTWA generation csv file re-download

Siedlerchr · 2025-06-09T13:56:17Z

 public class CitationStyleCatalogGenerator {
    private static final String STYLES_ROOT = "/csl-styles";
-    private static final String CATALOG_PATH = "build/resources/main/citation-style-catalog.json";
+    private static final String CATALOG_PATH = "build/generated/resources/citation-style-catalog.json";


Are you sure this is correct? This will break at runtime I think

No, because this is part of the source sets - see the whole diff for build.gradle.kts

Siedlerchr · 2025-06-12T20:53:48Z

            displayName: macOS (ARM64)
            suffix: '_arm64'
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.os == 'ubuntu-22.04-arm' && 'ubuntu-22.04' || matrix.os }}


this is the wrong approach, it loads the wrong jdk

this is the wrong approach, it loads the wrong jdk

If we stay on cross compiling:

JDK does has to match runner OS (currently happening)

JMODs of target OS have to be downloaded

jpackage (jlink?) has to be taught to use the downloaded JMODs instead of the ones shipped with the JDK.

Reason: .class files are portable, JMODs are platform-specific. Exceptional behavior for javafx jars is handled by some gradlex plugin.

is wrong. It download amd jdk for arm -> wrong

I did a PR here to test this with ubuntu arm and it seemed to work jjohannes/java-module-system#2

I think, we need to work on gradlex-org/java-module-packaging#57 (comment)

jpackage (jlink?) has to be taught to use the downloaded JMODs instead of the ones shipped with the JDK.

Is this possible? (If yes, do you have a link to documentation how to do this?)
My understanding it that it is not. That's why the packaging task has the validation that fails if you run it on the wrong os/arch.

@jjohannes thank you so much for the effort taken!! We should have known it, because we switch back and forth JDKs and are "aware" of JavaFX being packed. Maybe we try with our good old friend LibericaJDK without (!) JavaFX. - Thank you again for your patience. We will pick up from here.

I took another look at the pipeline today and it seesm that gradle downloads the zulu java with javafx https://api.foojay.io/disco/v3.0/ids/796901cbf89fc850a3f3bb8ddfe4506c/redirect
That resolves to zulu24.30.13-ca-fx-jdk24.0.1

gradle downloads zulu, because we use the foojay gradle toolchain plugin. You changed to amazon at 3a3097a (#13258).

Background: We try to keep the runtime for the build system (gradle) and the compiler used by gradle (JDK in toolchain) in version sync, but not necessarily always in JDK sync. Sometimes, we even update the JDK used by gradle (See gradle/gradle#33310).

Yes, the problem was that gradle downloads a zulu version which includes javafx through the foojay resolver plugin and thus we didn't use the openjfx from maven central

koppor · 2025-06-14T15:32:57Z

On maven central, only linux amd64 build should be published; reason: JabRef .class files are re-usable across different platforms; no need to publish for mac, linux, windows.

Therefore, I had the excact check for ubuntu-22.04 (and removed startsWith)

Siedlerchr · 2025-06-14T15:38:54Z

On maven central, only linux amd64 build should be published; reason: JabRef .class files are re-usable across different platforms; no need to publish for mac, linux, windows.

I don't see any changes I did for this. Maybe I overlooked something?

koppor · 2025-06-14T15:41:23Z

On maven central, only linux amd64 build should be published; reason: JabRef .class files are re-usable across different platforms; no need to publish for mac, linux, windows.

I don't see any changes I did for this. Maybe I overlooked something?

d4b2ef7 (#13258)

publish...MavenCentral publishes to maven central. Should only run on ubuntu-22.04 - not ubuntu-22.04-arm.

This reverts commit bfa8874.

This reverts commit 2e582a5.

trag-bot · 2025-06-14T16:22:53Z

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

github-actions · 2025-06-14T16:39:51Z

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

Siedlerchr · 2025-06-14T16:54:45Z

Argh:
Now we still have some duplicate stuff, that comes from the repack I think

Siedlerchr · 2025-06-14T17:02:47Z

But it works now

Siedlerchr · 2025-06-15T13:51:05Z

I merge now and we do a follow up

* upstream/main: New Crowdin updates (JabRef#13330) Add arm 64 linux runner (JabRef#13258) Rename strings and variables in New Entry (JabRef#13312) Let consistency checker yield a return code (JabRef#13329) Update LETTER fragment to resolve Windows parsing issue (JabRef#13327) Add support for "dev: no-bot-comments" Update dependency org.hibernate.validator:hibernate-validator to v9.0.1.Final (JabRef#13322) Endnote XML Exporter: Move factory initialization to constructor (JabRef#13321) Refine assignment reminder (JabRef#13315) Add welcome message to first time contributors (JabRef#13314) New Crowdin updates (JabRef#13311) Added a setting to show File annotations' tab only when the PDF actually contains highlights or comments (JabRef#13279) Update dependency org.postgresql:postgresql to v42.7.7 (JabRef#13306) Refine PULL_REQUEST_TEMPLATE.md (JabRef#13304) Move module tweaking of merged module to launcher (JabRef#13303) Speed up gradle update (JabRef#13300) testImplementation is enough (JabRef#13299)

* upstream/main: New Crowdin updates (JabRef#13330) Add arm 64 linux runner (JabRef#13258) Rename strings and variables in New Entry (JabRef#13312) Let consistency checker yield a return code (JabRef#13329) Update LETTER fragment to resolve Windows parsing issue (JabRef#13327) Add support for "dev: no-bot-comments" Update dependency org.hibernate.validator:hibernate-validator to v9.0.1.Final (JabRef#13322) Endnote XML Exporter: Move factory initialization to constructor (JabRef#13321) Refine assignment reminder (JabRef#13315) Add welcome message to first time contributors (JabRef#13314)

Siedlerchr added 3 commits June 4, 2025 20:51

Add arm 64 linux runner

adef6e0

Fixes #10842 https://github.com/actions/partner-runner-images/blob/main/images/arm-ubuntu-22-image.md

configure gradlex plugin for aarch64 linux

c2f63df

print arch

30296cd

koppor mentioned this pull request Jun 5, 2025

Why does the plugin not work with automatic modules? gradlex-org/java-module-packaging#57

Closed

koppor added 2 commits June 5, 2025 03:35

Merge remote-tracking branch 'origin/main' into addArm64

8c6f5e5

Add assemble as explicit step

81cf4db

koppor reviewed Jun 5, 2025

View reviewed changes

Comment thread build-logic/src/main/kotlin/buildlogic.java-common-conventions.gradle.kts Outdated

koppor added dev: binaries Binary builds should be uploaded to builds.jabref.org dev: build-system dev: ci-cd labels Jun 5, 2025

Siedlerchr and others added 2 commits June 5, 2025 21:25

Update build-logic/src/main/kotlin/buildlogic.java-common-conventions…

64b4bac

….gradle.kts Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Merge remote-tracking branch 'origin/main' into addArm64

a769a54

koppor added 4 commits June 8, 2025 15:47

Merge remote-tracking branch 'origin/main' into addArm64

17644e6

Improve dependencies in gradle file generation tasks

4cef743

Improves gradle caching for file-genratation tasks

ad0d84e

Additionally: - Fix LTWA generation csv file re-download

Add required "resourcesPackage" directories

4f2e3cf

trag-bot Bot reviewed Jun 9, 2025

View reviewed changes

Comment thread jablib/src/main/java/org/jabref/generators/JournalListMvGenerator.java Outdated

Seperate the steps..

a15e184

Siedlerchr commented Jun 9, 2025

View reviewed changes

koppor added 5 commits June 9, 2025 15:58

Try to fix build

e819397

Rly fix build

1bf5e58

Fix condition (to publish on maven central only for Linux)

ed256fc

Fix LTWA output path

f60d4e3

Log target

7a1df87

Siedlerchr reopened this Jun 12, 2025

Siedlerchr commented Jun 12, 2025

View reviewed changes

jjohannes mentioned this pull request Jun 13, 2025

Add 'ubuntu-22.04-arm' target #13317

Closed

koppor and others added 6 commits June 13, 2025 12:41

No cross-platform jpackage

ebeabad

test with inlcuded fx

885a0f2

switch to amazon in build.gradle

3a3097a

add ${{ matrix.archForDebianRepack }}

d4b2ef7

adapt binariesea

63fcf7b

adapt binariesea

a115aab

koppor mentioned this pull request Jun 14, 2025

Really use JavaFX EA in binaries-ea #13276

Closed

1 task

Siedlerchr added 5 commits June 14, 2025 17:44

publish only for amd

df5b3f3

adapt javafx download for ea

2e582a5

try with sed e

bfa8874

Revert "try with sed e"

17eaaad

This reverts commit bfa8874.

Revert "adapt javafx download for ea"

f5ce71b

This reverts commit 2e582a5.

Siedlerchr enabled auto-merge June 15, 2025 13:51

Siedlerchr disabled auto-merge June 15, 2025 13:51

Siedlerchr merged commit 8e04a99 into main Jun 15, 2025
2 checks passed

Siedlerchr deleted the addArm64 branch June 15, 2025 13:51

koppor mentioned this pull request Jun 15, 2025

Consistent use of single quotes #13333

Merged

1 task

Uh oh!

Conversation

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

Uh oh!

Steps to test

Mandatory checks

Uh oh!

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

Uh oh!

Uh oh!

Siedlerchr commented Jun 4, 2025

Uh oh!

jjohannes commented Jun 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

koppor commented Jun 7, 2025

Uh oh!

jjohannes commented Jun 7, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koppor commented Jun 14, 2025

Uh oh!

Siedlerchr commented Jun 14, 2025

Uh oh!

koppor commented Jun 14, 2025

Uh oh!

trag-bot Bot commented Jun 14, 2025

Uh oh!

github-actions Bot commented Jun 14, 2025

Uh oh!

Siedlerchr commented Jun 14, 2025

Uh oh!

Siedlerchr commented Jun 14, 2025

Uh oh!

Siedlerchr commented Jun 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Siedlerchr commented Jun 4, 2025 •

edited by koppor

Loading

Siedlerchr commented Jun 4, 2025 •

edited

Loading