Resources

Run as Docker Container

Instead of building the software from the sources and run it as Java program on the JVM it must be pulled as a Docker image from Docker Hub and started as a Docker container.

$ docker run openwms/org.openwms.common.service:latest

Build

The module depends on OpenWMS.org CORE dependencies and one optional COMMON dependency that is only used in the enterprise version and offers additional API for the UI.

Build a runnable fat jar with the execution of all unit and integration tests, but without a required RabbitMQ server to run:

$ ./mvnw package

To also build and run integration tests against a running RabbitMQ instance call:

$ ./mvnw package -DsurefireArgs=-Dspring.profiles.active=ASYNCHRONOUS,TEST

This requires a RabbitMQ server running locally with default settings.

Release Binaries

Releasing a new stable version of the software to Maven Central is usually done by the service maintainers only. To build an optimized and signed binary version and upload it to the Sonatype Staging Repository call:

$ ./mvnw deploy -Prelease,gpg

After it is uploaded, Sonatype runs a couple of quality checks before it can be manually released to Maven Central.

Release Documentation

To release the API documentation as a static website manually just call the following two Maven commands. This is integrated into the automated build pipeline as well.

$ ./mvnw package -DsurefireArgs=-Dspring.profiles.active=ASYNCHRONOUS,TEST
$ ./mvnw site scm-publish:publish-scm

Extension Points