From b5a8ef84f4f37d05e862b0e3bc724d753ae280d7 Mon Sep 17 00:00:00 2001 From: Martin Plieske Date: Wed, 26 Nov 2025 00:14:21 +0100 Subject: [PATCH 1/2] #192: Add BUILD.md --- BUILD.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 BUILD.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 00000000..294cd85d --- /dev/null +++ b/BUILD.md @@ -0,0 +1,39 @@ +# Build + +The following instructions explain how to build KeepTime from sources. + +## Prerequisites + +* JDK with JavaFx + * 17 ✅ + * 21 ✅ + * 23 ✅ + * 25 ❗ (Compatible for building without test) +* Maven + +Amazon Corretto JDK has JavaFx Bundled. +For other JDKs you may have to install JavaFx separately. + +The Mockito mocking library version in use for tests is not compatible with Java 25. +If you trust us and you don't need to run test but you just want to build from the stable `main` branch, Java 25 is supported. + +## Build Commands + +Run one of the following commands from the root directory of this project, where the `pom.xml` file is found. + +A zip file and a jar with dependencies bundled with it will be created at the `target` directory. +If you don't use the profile `coverage`, crutial parts of the application will not be built. + +### Build Without Tests + +`mvn package -P coverage -D maven.test.skip true` + +Only recommended on the stable `main` branch. + +### Build With Tests + +`mvn package -P coverage` + +### Build With Coverage Reports + +`mvn package org.jacoco:jacoco-maven-plugin:0.8.7:prepare-agent org.jacoco:jacoco-maven-plugin:0.8.7:report -P coverage` From 7a175877a5cd6064510144ebb657ee2b3eb5d055 Mon Sep 17 00:00:00 2001 From: Martin Plieske Date: Wed, 26 Nov 2025 01:12:58 +0100 Subject: [PATCH 2/2] #192: Remove bad information Remove information on compatability with Java 25 when building without tests. --- BUILD.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/BUILD.md b/BUILD.md index 294cd85d..e4b845d1 100644 --- a/BUILD.md +++ b/BUILD.md @@ -8,14 +8,13 @@ The following instructions explain how to build KeepTime from sources. * 17 ✅ * 21 ✅ * 23 ✅ - * 25 ❗ (Compatible for building without test) + * 25 ❗ * Maven Amazon Corretto JDK has JavaFx Bundled. For other JDKs you may have to install JavaFx separately. -The Mockito mocking library version in use for tests is not compatible with Java 25. -If you trust us and you don't need to run test but you just want to build from the stable `main` branch, Java 25 is supported. +The Mockito mocking library version in use for tests is not compatible with Java 25. ## Build Commands