Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Build

The following instructions explain how to build KeepTime from sources.

## Prerequisites

* JDK with JavaFx
* 17 ✅
* 21 ✅
* 23 ✅
* 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.

## 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`
Loading