building.md

Building Aurora

Aurora libraries are built with Gradle. Each library has its own build.gradle.kts file, and the top-level build.gradle.kts has tasks to build, package and deploy Aurora artifacts.

Java requirements

Aurora is built with Java 11. Search for "Java 11 download" in your favorite search engine, or browse this page (and perhaps the archives that it points to) to get the JDK distribution for your environment.

Local artifacts

• To build library artifacts, run ./gradlew build in your terminal.
• After this command completes, the packaged jar files will be under the matching library folders.
• To copy all the jars under one location, run ./gradlew copyJars command.
• For version X.Y of Aurora (see VERSION_NAME in gradle.properties), the artifacts will be copied into the drop/X.Y folder.

Local third-party dependencies

Some Aurora libraries have third-party dependencies. To print the full dependency tree, run ./gradlew printRuntimeDependencies. Here is a snippet that shows the dependencies for SVG Transcoder:

-------- svg-transcoder --------
org.jetbrains.compose.desktop:desktop:1.6.10-rc03
org.apache.xmlgraphics:batik-all:1.17

To locally copy these dependencies (in case you do not want to pull them at build time with Gradle, Maven or other similar build tools in your own environment), use ./gradlew getDependencies. Once that command completes, all dependencies will be in the build/libs folder.

For a more detailed tree of dependencies, run ./gradlew tools:svg-transcoder:dependencies - substituting the relevant module name.

Publishing to Maven Local

Run ./gradlew publishToMavenLocal to publish to the local Maven repository.