Skip to content

Latest commit

 

History

History
68 lines (54 loc) · 2.61 KB

BUILD.MD

File metadata and controls

68 lines (54 loc) · 2.61 KB
Raw

Build instructions

In these instructions, actions performed in the Windows command line are prefixed with >, and those on the Unix shell are prefixed with $. Select the command appropriate for your platform.

How to build the software from source

Once you have cloned the repository, run the following command:

> gradlew
$ ./gradlew

You may decide to add the -PSpotBugs=true flag to check for bugs. This is disabled by default. e.g. gradlew -PSpotBugs=true

Creating a custom JRE

Utilising Spotbugs feature

You can make Gradle find any potential bugs by running a standard gradlew build.

Then, download the Spotbugs GUI and run the GUI from /lib/spotbugs.jar. Open the generated XML file in this software to see where all the potential bugs are.

How to build the software, for distribution

# Make sure local repository is clean, so that you get the same result as a first time user
> gradlew clean
$ ./gradlew clean

# Running the packageApp task will compile all code, generate JAR files for all modules and dependencies, and package
everything up into Zip and Tar formats.
> gradlew packageApp
$ ./gradlew packageApp

Distributing JREs

There are a number of JRE related tasks in jre.gradle that will download a specific JRE from Zulu Community JREs, that include JavaFX. Each platform has the same tasks;

  • Download the JRE
  • Unzip the JRE to your Maven local repository
  • Copy the JRE to the build folder when creating distributions.

Before running distribution for the first time, you must run

> gradlew downloadAndExtractJREs
$ ./gradlew downloadAndExtractJREs

The JREs will be downloaded to your local Maven repository. By default, this will be /home/user/.m2/repository/jre on UNIX, and C:\Users\current user\.m2\repository\jre on Windows.

Any future builds will rely on these folders being present locally. You can always rerun the task to restore your repository.

The JRE can then be found in the build folder and will be built into the distribution for the relevant OS.

How to release the software, for version tagging in the official SCM and binary distribution

# Make sure local repository is clean, so that you get the same result as a first time user
> gradlew clean
$ ./gradlew clean

# Run the release task and follow the on-screen instructions. This will fail if any changes haven't been commited or 
pushed.
> gradlew release
$ ./gradlew release