This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Page Comparison - Building from Source (v.4 vs v.5) - API Manager 1.8.0 - WSO2 Documentation

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


A WSO2 platform release is a set of WSO2 products based on the same Carbon release. For example, Turing is the platform release name for WSO2 Carbon 4.2.0 and the WSO2 products that are based on it. Usually, not all products in a platform get released at the same time, so they are released in chunks, each of which contains the Carbon release and a subset of products. For example, chunk 8 the API Manager 1.8.0 comes in chunk 14 of the Turing platform release contains Carbon 4.2.0 plus Task Server 1.1.0, Data Services Server 3.2.0 and Complex Event Processor 3.1.0 . 

Checking out the patches


$ svn checkout<release-chunk>/ <local-platform-directory-2>

Replace <release-chunk> with the release chunk, on which the specific product version is based on. To find out the respective release chunk, see the Release Matrix. For example, for products based on Chunk 08 14 of WSO2 Carbon 4.2.0, the command is as follows:

$ svn checkout <local-platform-directory-2>


Make sure the build server has an active Internet connection to download dependencies while building.
  1. Install Maven and JDK. See See Installation Prerequisites for compatible versions. 
  2. Set the environment variable  MAVEN_OPTS="-Xms1024m -Xmx4096m -XX:MaxPermSize=1024mto avoid the Maven OutOfMemoryError.
  3. Navigate to each folder representing the patches within the  the <local-platform-directory-1> and run the following Apache Maven commands to build the patches. For information on the patches, which are applicable for the respective Carbon chunk release, go to Release Matrix

    This command...Creates...
    mvn clean install

    The binary and source distributions of the chunk release.

    mvn clean install -Dmaven.test.skip=trueThe binary and source distributions, without running any of the unit tests.
    mvn clean install -Dmaven.test.skip=true -o The binary and source distributions, without running any of the unit tests, in offline mode. This can be done only if you've already built the source at least once.
  4. For products based on Carbon 4.2.0, to create complete release artifacts of the products released with this chunk version, including the binary and source distributions, go to    <localto <local-platform-directory-2>/product-releases/ <release-chunk>/ directory  directory and run the Apache Maven commands stated in the above step.   To build only a selected product/s , open   open <local-platform-directory-2>/product-releases/<release-chunk>/products/pom.xml  file, and comment out the products you do not want to build and run the relevant Maven command.

After building the source, you can find the artifacts/product binary distribution package of the product in the directory:
<local-platform-directory-2>/products/<product_name>/<product_release_version>/modules/distribution/target/ directory.