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:
Building from source is optional. Users who do not want to make changes to the source code can simply download the binary distribution of the product and install it.
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 8 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 . 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. 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>CEP 3.1.0 is released in Turing chunk 8, which you can download using the checkout command as shown below. Replace <local-platform-directory-1> and with a meaningful name, such as wso2carbon-platform.
$ svn checkout https://svn.wso2.org/repos/wso2/carbon/platform/tags/turing-chunk08 <local-platform-directory-2>Building the product
Follow the instructions below to build the product:
- Install Maven and JDK. See Installation Prerequisites for compatible versions.
- Set the environment variable
MAVEN_OPTS="-Xms1024m -Xmx4096m -XX:MaxPermSize=1024m" to avoid the MavenOutOfMemoryError. Navigate to each folder representing the patches within 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 installThe 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. - To create complete release artifacts of the products released with this chunk version, including the binary and source distributions, go to
<local-platform-directory-2>/repos/wso2/carbon/platform/tags/turing-chunk08/product-releases/chunk-08and run the Apache Maven commands stated in the above step. To build only a selected product/s, open<local-platform-directory-2>/repos/wso2/carbon/platform/tags/turing-chunk08/product-releases/chunk-08/products/pom.xmlfile, 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:
| If you are using this IDE... | Run this command... | Additional information |
|---|---|---|
| Eclipse | mvn eclipse:eclipse | http://maven.apache.org/plugins/maven-eclipse-plugin |
| IntelliJ IDEA | mvn idea:idea | http://maven.apache.org/plugins/maven-idea-plugin |
If you are using a later Eclipse version and if you get errors (library path etc.) when trying to import the source code using the Exisiting Projects into Workspace, follow the steps below to solve them by importing the source code as a Maven project.
- Build the source using the command:
mvn clean install - Open Eclipse and click Import in the File menu and then click Exisiting Maven Projects as shown below:
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"