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 1 of the Turing platform release contains Carbon 4.2.0 plus DSS 3.1.0 and IS 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>
WSO2 MB 2.2.0 is released in Turing chunk 11, 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-chunk11 <local-platform-directory>
Building the product
Before you build:
- Make sure the build server has an active Internet connection to download dependencies while building.
- 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.
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-chunk11/product-releases/chunk-11 and run the following Apache Maven commands. To build only a selected product/s, open the <local-platform-directory>/repos/wso2/carbon/platform/tags/turing-chunk11/product-releases/chunk-11/products/pom.xml file, comment out the products you do not want to build and run the relevant Maven command.
| Command | Description |
|---|---|
mvn clean install | The binary and source distributions of the chunk release. |
mvn clean install -Dmaven.test.skip=true | The 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. |
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:
| IDE | 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 Existing 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 Existing 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"