Versions Compared

Key

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

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:

...

You can download the complete WSO2 Carbon platform, 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 and <local-x-directory>with meaningful names, such as: svn checkout https://svn.wso2.org/repos/wso2/carbon/orbit/tags/4.1.0 wso2carbon-orbit

Orbit:

$ svn checkout https://svn.wso2.org/repos/wso2/carbon/orbit/tags/x.x.x <local-orbit-directory>

...

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

...

Info

If you will not be committing changes, you can use HTTP instead of HTTPS to download the source more quickly. If you are behind a corporate firewall

...

$ svn checkout https://svn.wso2.org/repos/wso2/trunk/carbon wso2carbon

, however, you might need to use HTTPS if your access is blocked. 

Access through a proxy

The Subversion client can be configured to access the repository through a proxy. Specify the proxy to use in the "servers" configuration file in: 

...

Following are the Apache Maven commands you can run to create complete release artifacts of WSO2 ESB, including the binary and source distributions. If you only want to build the ESB, use the -Dproduct=esb option as shown. If you want to build the entire Carbon core project, omit the -Dproduct=esb option.

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=”-Xms768m -Xmx3072m -XX:MaxPermSize=1200m to avoid the Maven OutOfMemoryError.
CommandDescription
mvn clean install -Dproduct=esbThe binary and source distributions
mvn clean install -Dmaven.test.skip=true -Dproduct=esbThe binary and source distributions, without running any of the unit tests.
mvn clean install -Dmaven.test.skip=true -Dproduct=esb -oThe 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.

...