Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Building from the source involves the following steps:

  1. Checkout the source
  2. Build using Maven

  3. Setup your development environment
  4. Commit your changes

...

Table of Contents
maxLevel3
minLevel3

Checking Out the Source

You can download the complete WSO2 Carbon platform, which is recommended if you intend to modify the source. You can check out the complete source anonymously from SVN with the following commands (replace x.x.x with the version of Carbon you want to build). The Carbon project comes in three sub projects that are namely, Orbit, Kernel and Platform. Download and build them in that particular order. 

...

Code Block
[global]
http-proxy-host = your.proxy.name
http-proxy-port = 3128

...

Building the Product

The following are the commands you can run to create complete release artifacts of WSO2 IS, including the binary and source distributions. Before you start,

  • Install Maven and JDK. See Installation Prerequisites for compatible versions. 
  • Set the environment variable MAVEN_OPTS=”-Xms768m -Xmx3072m -XX:MaxPermSize=1200m” to avoid the maven OutOfMemoryError.
  • Make sure the build server has an active Internet connection to download dependencies while building.

Building using Maven

The following are the commands you can run to create complete release artifacts of WSO2 Carbon, including the binary and source distributions.

  • To build the binary and source distributions.

    Code Block
    mvn clean install
  • To build the binary and source distributions, without running any of the unit tests.

    Code Block
    mvn clean install -Dmaven.test.skip=true
  • To build the binary and source distributions, without running any of the unit tests, in offline mode. This can be done only if you have already built the source at least once.

    Code Block
    mvn clean install -Dmaven.test.skip=true -o

...

Setting up your Development Environment

You need to setup your development environment to be able to edit the source code according to your requirement. Setup the environment using one of the following commands:

  • If you are using Eclipse use the following command:

    Code Block
    mvn eclipse:eclipse
  • If you are using intelliJIDEA use the following command:

    Code Block
    mvn idea:idea

...

Committing your Changes

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

...