Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Refine build instructions, targeting developers.

Download Geode source from one of two places: an find a specific Apache Geode (incubating) release from httpat https://geodegithub.incubator.apache.org/ or com/apache/incubator-geode/releases or use the head of the develop branch at https://github.com/apache/incubator-geode. Build instructions for an each Apache Geode (incubating) release are in the README.md or BUILDING.md file within the release. Both sets of the source code use the standard Gradle lifecycle model.

These instructions are targeted to build from the head of the develop branch. All builds require a JDK, version 1.8 or a more recent version.  Set a JAVA_HOME environment variable to point to the Java installation. 

Make a clone of the develop branch:

git clone -b develop https://github.com/apache/incubator-geode.git

Build on Unix

Within the incubator-geode directory, to build, run the tests, create binary artifacts, and create a distribution:

./gradlew build installDist

To build, create binary artifacts and create a distribution, but not run the tests:

...

The distribution archives will be located in geode-assembly/build/distributions/. To install from the distribution, extract the archive file and add the bin directory to your path.

Binary artifacts The gfsh script will also be in geode-assembly/build/install/apache-geode/bin.

...

Within the incubator-geode directory folder, to build, run the tests, create binary artifacts, and create a distribution:

gradle build installDist

To build, create binary artifacts and create a distribution, but not run the tests:

...

The distribution archives will be located in geode-assembly\build\distributions\. To install from the distribution, extract the archive file and add the bin directory to your path.

Binary artifacts The gfsh.bat script will also be in geode-assembly\build\install\apache-geode\bin.

...