Building from Source

WSO2 invites you to contribute by checking out the source from the Subversion (SVN) source control system, building the product and making changes, and then committing your changes back to the source repository. (For more information on Subversion, see http://svnbook.red-bean.com.) The following sections describe this process:

Checking out the source

WSO2 products are built on top of WSO2 Carbon Kernel, which contains the Kernel libraries used by all products. When there are changes in the Carbon Kernel, they are bundled and released in a new WSO2 Carbon version (for example, WSO2 Carbon 4.2.0).

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 1 of the Turing platform release contains Carbon 4.2.0 plus Data Services Server 3.1.0, Application Server 5.2.0, and Identity Server 4.5.0. When you want to build a product from source, you download and build the appropriate platform chunk. (To determine which chunk to use for a specific product version, see the Release Matrix).

You need to checkout the patches related to the Carbon chunk using the following command, before checking out the product source. Replace <local-platform-directory-1> and with a meaningful name, such as wso2carbon-platform.

$ svn checkout https://svn.wso2.org/repos/wso2/carbon/kernel/branches/4.2.0/patches/ <local-platform-directory-1>

Data Services Server 3.1.0 is released in Turing chunk 1, which you can download using the checkout command as shown below (replace <local-platform-directory> with a meaningful name, such as wso2carbon-platform):

$ svn checkout https://svn.wso2.org/repos/wso2/carbon/platform/tags/turing-chunk01 <local-platform-directory>

Building the product 

Before you build:

1. Make sure the build server has an active Internet connection to download dependencies while building.
2. Install Maven and JDK. See Installation Prerequisites for compatible versions.
   
3. Set the environment variable  MAVEN_OPTS=”-Xms1024m -Xmx4096m -XX:MaxPermSize=1024m” to avoid the Maven OutOfMemoryError.

To create complete release artifacts of the products released with this chunk version, including the binary and source distributions, go to <local-platform-directory>/repos/wso2/carbon/platform/tags/turing-chunk01/product-releases/chunk-01 and run the following Apache Maven commands. To build only a selected product/s, open <local-platform-directory>/repos/wso2/carbon/platform/tags/turing-chunk01/product-releases/chunk-01/products/pom.xml file, comment out the products you do not want to build and run the relevant maven command.

Setting up your development environment

Before you edit the source code in your IDE, set up your development environment by running one of the following commands:

Committing your changes 

If you are a committer, you can commit your changes using the following command (SVN will prompt you for your password):

$ svn commit --username your-username -m "A message"