Versions Compared

Key

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

...

...

...

...

...

...

Excerpt
hiddentrue

Add this version of the "Building from Source" page for products based on Carbon 4.2.0.

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:

...

$ svn checkout https://svn.wso2.org/repos/wso2/carbon/kernel/branches/4.2.0/patches/ <local-platform-directory-1>

...

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

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:

If you are using this IDE...Run this command...Additional information
Eclipsemvn eclipse:eclipse http://maven.apache.org/plugins/maven-eclipse-plugin
IntelliJ IDEAmvn 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.

  1. Build the source using the command: mvn clean install
  2. Open Eclipse and click Import in the File menu and then click Existing Maven Projects as shown below: 
    Image Added

Building the product 
Anchor
build
build

Follow the instructions below to build the product after editing the source code:

Info
Make sure the build server has an active Internet connection to download dependencies while building.
  1. Install Maven and JDK. See Installation Prerequisites for compatible versions.
  2. Set the environment variable  MAVEN_OPTS="-Xms1024m -Xmx4096m -XX:MaxPermSize=1024m" to avoid the Maven OutOfMemoryError.
  3. Navigate to each folder representing the patches within the  <local-platform-directory-1> and run the following Apache Maven commands to build the patches. For information on the patches, which are applicable for the respective Carbon chunk release, go to Release Matrix

    This command...Creates...
    mvn clean install

    The binary and source distributions of the chunk release.

    mvn clean install -Dmaven.test.skip=trueThe 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.
  4. For products based on Carbon 4.2.0, to create complete release artifacts of the products released with this chunk version, including the binary and source distributions, go to    <local-platform-directory-2>/ repos/wso2/carbon/platform/tags/turing-product-releases/ <release-chunk>/product-releases/   directory   and run the Apache Maven commands stated in the above step.  To build only a selected product/s , open   <local-platform-directory-2>/repos/wso2/carbon/platform/tags/turing-product-releases/ <release-chunk>/product-releasesproducts/pom.xml  file, and comment out the products you do not want to build and run the relevant Maven command.

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:

If you are using this IDE...Run this command...Additional information
Eclipsemvn eclipse:eclipse http://maven.apache.org/plugins/maven-eclipse-plugin
IntelliJ IDEAmvn 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 Exisiting Projects into Workspace, follow the steps below to solve them by importing the source code as a Maven project.

...

Info

After building the source , you can find the artifacts/product binary distribution package of the product in the <local-platform-directory-2> / products/<product_name>/<product_release_version>/ modules/distribution/target/ directory.

Committing your changes 
Anchor
commit
commit

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

...