User Documentation

See the Docs Directory for user docs.

Developer Documentation

Packaging Streamliner

Streamliner uses Gradle as a dependency management and build tool. The Gradle Application Plugin attempts to make building packages for different operating systems easier.

Creating Streamliner Package

1. Execute ./gradlew clean assemble
2. Copy zip from build/distributions/streamliner-<version>.zip to intended install directory
3. Unzip streamliner

Releasing

Install tools if required:

$ virtualenv -p python3 venv
$ source venv/bin/activate
$ pip install --upgrade cloudsmith-cli

Login to Cloudsmith:

$ cloudsmith token

Publish:

$ build-support/publish-zip.sh

Running Full Build

./gradlew build

Running Tests

Note: Some tests require Docker to be running.

./gradlew test