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
Anchor | ||||
---|---|---|---|---|
|
You can download the complete WSO2 products are built on top of WSO2 Carbon platformKernel, which is recommended if you intend to modify the source. The Carbon project comes in three sub projects: Orbit, Kernel, and Platform. Download and build them in that specific order. You can check out the source code anonymously using the checkout
command as shown in the following examples. Replace x.x.x
with the version of Carbon you want to build (Business Rules Server 2.1.0 is based on Carbon 4.2.0) and replace <local-x-directory>
with meaningful names, such as: svn checkout 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 9 of the Turing
platform release contains Carbon 4.2.0 plus BRS 2.1.0 and other products. 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).
ESB 4.8.1 is released in Turing
chunk 7, which you can download using the checkout
command as shown below
Anchor | ||||
---|---|---|---|---|
|
<localDir>
with a meaningful name, such as wso2carbon-platform
):$ svn checkout https://svn.wso2.org/repos/wso2/carbon/
...
platform/tags/
...
turing-chunk07 <localDir>
Orbit:
$ svn checkout https://svn.wso2.org/repos/wso2/carbon/orbit/tags/x.x.x <local-orbit-directory>
...
Following are the Apache Maven commands you can run to create complete release artifacts of WSO2 Business Rules Server, including the binary and source distributions. If you only want to build Business Rules Server, use the -Dproduct=brs
option as shown. If you want to build the entire Carbon core project, omit the -Dproduct=brs
option.
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=”-Xms768m -Xmx3072m -XX:MaxPermSize=1200m
” to avoid the MavenOutOfMemoryError.
Command | Description |
---|---|
mvn clean install -Dproduct=brs | The binary and source distributions |
mvn clean install -Dmaven.test.skip=true -Dproduct=brs | The binary and source distributions, without running any of the unit tests. |
mvn clean install -Dmaven.test.skip=true -Dproduct=brs -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. |
...