Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.27 KB

DEVELOPING.md

File metadata and controls

36 lines (25 loc) · 1.27 KB

Project Development

For general information about contributing changes, see the Contributor Guidelines.

How it Works

Titan is written with Kotlin for JVM and binaries are compiled using GraalVM.

Requirements

  • openjdk 1.8.0_212 (see notes for GraalVM)
  • GraalVM

###Setting up GraalVM

  • Install GraalVM
  • Set JAVA_HOME to be the openjdk include with GraalVM
  • Add the GraalVM bin directory to your PATH

Building

./mvnw clean install
java -jar ./target/titan-VERSION-jar-with-dependencies.jar

Once the jar is created, native binaries can be built with the following scripts.

./scripts/build-osx.sh
./scripts/build-linux.sh

## Testing

Describe how to test the project.

## Releasing

The version for the CLI is maintained with the `VERSION` file. Bump the version in this file and then run `./scripts/compile-maven.sh` to update the version in the POM.xml file and build a new versioned jar. Currently, an OSX binary release file needs to be committed to a proper release directory. If you are on OSX, run `./scripts/build-osx.sh` to create this file. CI/CD will handle the rest of the builds.