Add arm 64 linux runner #13258

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

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

    os.isWindows -> "windows-2022"
    else -> error("Unsupported OS")
 }

 // 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?

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

….gradle.kts Co-authored-by: Oliver Kopp <[email protected]>

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

jablib/src/main/java/org/jabref/generators/JournalListMvGenerator.java

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

jablib/src/main/java/org/jabref/generators/CitationStyleCatalogGenerator.java

@@ -28,7 +28,7 @@
 @AllowedToUseClassGetResource("Required for loading internal CSL styles")
 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

This reverts commit 268aee1.

* upstream/addArm64: Speed up gradle update (#13300) testImplementation is enough (#13299)

Siedlerchr · 2025-06-11T18:24:10Z

Cross compilation did not work because it used an x64 java. When I specify the architecture to aarch64 then it does not work either with gradle. thus I close this for th emoment as it's blocked by the java module issues

trag-bot · 2025-06-11T18:24:12Z

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

koppor · 2025-06-12T18:28:53Z

Cross compilation did not work because it used an x64 java. When I specify the architecture to aarch64 then it does not work either with gradle. thus I close this for th emoment as it's blocked by the java module issues

That means, also on your macOS machine following gradle task did not produce a valid arm64 image?

Background: I am trying to understand if we maybe can cross-compile from a non-linux.

./gradlew assembleUbuntu-22.04-arm

Siedlerchr · 2025-06-12T18:50:16Z

@koppor I downloaded the linux arm image build from the buids.jabref.org and tested it on an ubuntu arm vm

koppor · 2025-06-12T19:06:21Z

@koppor I downloaded the linux arm image build from the buids.jabref.org and tested it on an ubuntu arm vm

Could you mabe a) bulid the image on your machine and b) try it in the arm vm? 😅

Siedlerchr · 2025-06-12T19:38:01Z

What went wrong:
Execution failed for task ':jabgui:jpackageUbuntu-22.04-arm'.
Running on macosx; cannot build for linux

TL;DR you need the target runtime for the system. Jpackage cannot cross compile

koppor · 2025-06-12T19:39:15Z

Maybe, it boils down to Adoptium not shipping all jmods: adoptium/adoptium-support#1271 (comment)

Siedlerchr · 2025-06-12T19:41:58Z

But we use zulu

koppor · 2025-06-12T20:16:36Z

I bet that Zulu ships JMODs only for the JDK of the current platform - and not all.

Intermediate result:

There are hints for manually downloading the JDK and jmods at [JDK 24] Provide JMODs as a separate download for deployment tool compatibility adoptium/adoptium-support#1271 (comment) -- note that jmods have the same filename for each platform. Thus, to use ubuntu-arm and macOS - one neesd to have two different JDKs. - Or try to pass the jmod directory to jlink (as outlined in the linked issue)
One needs to move ´jdk-24.0.1+9-jmods/*intojdk-24.0.1+9/jmods/`
Remove toolchain (to disable out download)

Still

> Running on amd64; cannot build for aarch64

koppor · 2025-06-12T20:20:07Z

@jjohannes I am totally confused now. The exception comes from Java Module Packaging Gradle plugin:

throw new RuntimeException("Running on " + hostOs + "; cannot build for " + os);

github-actions · 2025-06-12T20:42:04Z

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

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

.github/workflows/binaries.yml

@@ -157,13 +157,16 @@ jobs:
          - os: macos-14
            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.

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

Open

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

build-logic/src/main/kotlin/buildlogic.java-common-conventions.gradle.kts Outdated Show resolved Hide resolved

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 <[email protected]>

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

jablib/src/main/java/org/jabref/generators/JournalListMvGenerator.java Outdated Show resolved Hide resolved

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

This was referenced Jun 9, 2025

Optimize build #13296

Open

Package for Linux aarch64 #10842

Open

koppor and others added 12 commits June 10, 2025 01:39

Add CHANGELOG.md entry

3906995

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

5fc8126

Merge branch 'main' into addArm64

fa7e4b8

remove extra amd suffix

268aee1

Revert "remove extra amd suffix"

540183c

This reverts commit 268aee1.

rename only repacked

536bcc8

list files

ca1c2e5

Merge branch 'main' into addArm64

0173d0a

try with arm architecuter explicit

960013b

Merge remote-tracking branch 'upstream/addArm64' into addArm64

5f19833

* upstream/addArm64: Speed up gradle update (#13300) testImplementation is enough (#13299)

try again with matrix os

2a1fda9

try again with aarch 64

33f9f00

Siedlerchr removed the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jun 11, 2025

Siedlerchr closed this Jun 11, 2025

Siedlerchr mentioned this pull request Jun 11, 2025

Add Ubuntu arm (aarch) target for testing jjohannes/java-module-system#2

Merged

Siedlerchr reopened this Jun 12, 2025

Siedlerchr commented Jun 12, 2025

View reviewed changes

Uh oh!

Add arm 64 linux runner #13258

Are you sure you want to change the base?

Add arm 64 linux runner #13258

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!

koppor Jun 5, 2025

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!

Siedlerchr Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

trag-bot bot commented Jun 11, 2025

Uh oh!

koppor commented Jun 12, 2025

Uh oh!

Siedlerchr commented Jun 12, 2025

Uh oh!

koppor commented Jun 12, 2025

Uh oh!

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

Uh oh!

Uh oh!

koppor commented Jun 12, 2025

Uh oh!

Siedlerchr commented Jun 12, 2025

Uh oh!

koppor commented Jun 12, 2025

Uh oh!

koppor commented Jun 12, 2025

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

Siedlerchr Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Siedlerchr commented Jun 4, 2025 •

edited by koppor

Loading

Siedlerchr commented Jun 4, 2025 •

edited

Loading

Siedlerchr commented Jun 11, 2025 •

edited

Loading

Siedlerchr commented Jun 12, 2025 •

edited

Loading