From cc5176857978d2def41645e39adc2aec2707dd9d Mon Sep 17 00:00:00 2001 From: bono007 Date: Tue, 27 Jul 2021 15:22:00 -0500 Subject: [PATCH] Add section in README.adoc pointing to ci-docker-compose scripts. --- README.adoc | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.adoc b/README.adoc index 2c08a85ce..8bf85c9d5 100644 --- a/README.adoc +++ b/README.adoc @@ -1181,19 +1181,22 @@ You can consume these exceptions with your own Spring Integration flow. === Basic Compile and Test -To build the source you will need to install JDK {jdkversion}. +Pre-requisites: + +* To compile, JDK {jdkversion} installed. +* To run tests, RabbitMQ server running on `localhost:5672` + The build uses the Maven wrapper so you don't have to install a specific -version of Maven. To enable the tests, you should have RabbitMQ server running -on localhost and the default port (5672) -before building. - -The main build command is +version of Maven. The main build command is ---- $ ./mvnw clean install ---- +NOTE: There are scripts in `./ci-docker-compose` that use https://docs.docker.com/compose//[Docker Compose] to +start/stop a local RabbitMQ server. + You can also add '-DskipTests' if you like, to avoid running the tests. NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command @@ -1209,11 +1212,6 @@ build succeed, please raise a ticket to get the settings added to source control. -The projects that require middleware generally include a -`docker-compose.yml`, so consider using -https://compose.docker.io/[Docker Compose] to run the middeware servers -in Docker containers. - === Documentation There is a "docs" profile that will generate documentation.