WSO2 invites you to contribute by checking out by downloading the source code from the Subversion (SVN) GitHub 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:
...
| Info |
|---|
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. |
Downloading the source
| Anchor | ||||
|---|---|---|---|---|
|
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 new WSO2 Carbon version (for example, WSO2 Carbon 4.23.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 10 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).
WSO2 MB 2.2.0 is released in Turing chunk 10, 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-chunk10 <local-platform-directory>
...
Before You can download the complete WSO2 Kernel release using the following repository: https://github.com/wso2/carbon4-kernel, which is recommended if you intend to modify the source. After downloading the source of the Carbon Kernel, execute the following command to download the source of the product: git clone https://github.com/wso2/product-mb.
| Note |
|---|
After the source code is downloaded, you can start editing. However, it is recommended to run a build prior to changing the source code to ensure that the download is complete. |
After downloading the source of the Carbon Kernel, execute the following command to download the source of the product: git clone https://github.com/wso2/product-mb
Editing the source code
Now that you have downloaded the source code for the Carbon project from GitHub, you can prepare your development environment and do the required changes to the code.
To 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:eclipsehttp://maven.apache.org/plugins/maven-eclipse-plugin IntelliJ IDEA mvn idea:ideahttp://maven.apache.org/plugins/maven-idea-plugin - Add the required changes to the source code.
| Anchor | ||||
|---|---|---|---|---|
|
Ensure that the following prerequisites are in place before you build:
- Make sure the build server has an active Internet connection to download dependencies while building.
- Install Maven and JDK. See For compatible versions, 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-chunk10/product-releases/chunk-10 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-chunk10/product-releases/chunk-10/products/pom.xml file, comment out the products you do not want to build and run the relevant Maven command.Use the following Maven commands to build your product:
| 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 have already built the source at least once. |
...
Committing your
...
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 a committer, you can commit your changes using the following command (SVN will prompt you for your password):
...
changes
You can contribute to WSO2 products by committing your changes to GitHub. Whether you are a committer or a non-committer, you can contribute with your code as explained in the Get Involved section.