Difference between revisions of "Stardust/Source Code"

Revision as of 05:32, 5 July 2012

Installing Git

To checkout the source code your need to install git. You have different options, for instance:

• [git scm] installs a minimal environment to run Git. It comes with a Bash,a Perl interpreter and the Git executable plus dependencies.
• [msysgit] installs a build environment for Git on Windows. It includes git scm.

After installing a git environment you can open a git shell to run git commands (git bash or git-cmd.bat)

Downloading the Source Code

1. Create a new folder and open a git shell in it. (bash on Linux/Win or git-cmd.bat on Win)
2. Copy the following commands in a cloneStardust.cmd or scloneStardust.sh file and run it (or run the commands individually)

git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.build.tools.git build.tools
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.ui.common.git common
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.components.git components
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.documentation.git documentation
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.engine.git engine
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.ide.git ide
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.ide.simulation.git ide.simulation
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.ide.wst.git ide.wst
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.git org.eclipse.stardust
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.product.git product
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.reporting.rt.git reporting.rt
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.reporting.app.web.git reporting.app.web
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.reporting.ui.git reporting.ui
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.ui.web.git ui.web
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.repository.git repository
git clone http://git.eclipse.org/gitroot//stardust/org.eclipse.stardust.ui.common.git ui.common

If you run git clone behind a HTTP proxy specify proxy details first.

git config --global http.proxy http://<user>:<password>@proxy:port

Building Stardust

Build Tools

To build Stardust from the source code you check out as described above you need Apache Ant and Apache Maven. If you do not already have those tools installed please download them from their official websites and install them according to their installation instructions in a location of your choice, later called ANT_HOME and M2_HOME. We suggest Ant 1.8.4 and Maven 3.0.4, but other similar versions should work as well. After those preparations are done perform the following steps ( also see the readme.txt in the product folder).

Environment-specific Changes

Make sure your environment variables ANT_HOME, M2_HOME and JAVA_HOME are set correctly and ant and maven are on your path. In the following all relative paths are relative to the build folder - the one in which you downloaded the source code. Create a file called private.properties in the folder build.tools\etc. Modify the file with a text editor and add the following content:

java16.home=[your java home path]
m2.home=[your maven home path]

for instance:
java16.home=C:/Program Files/Java/jdk1.6.0_32

m2.home=C:/tools/apache-maven-3.0.4

Maven Configuration

<server>
  <id>stardust-3rdparty-repo</id>
  <username>stardust.contributor</username>
  <password>\{DESede\}BKab8uCs+3KRLHy/l2AeHQ==</password>
</server>

Running the Builds

Make sure your machine is connected to the internet, open a command line in your build folder and then execute these two commands replacing [build_tools_home] with the absolute path to you build.tools sub folder:

set MAVEN_OPTS=-Xmx768m -XX:MaxPermSize=128m

mvn -f product/components-pom.xml -Pipp-build -Dbuild.tools.home=[build_tools_home] install

For instance:

mvn -f product/components-pom.xml -Pipp-build -Dbuild.tools.home=c:/stardustbuild/build.tools install

Depending on your connection speed and other factors the completion of the second command can take up to several hours. After the build of the components has finished successfully, you should find the resulting artefacts in your local maven repository. Now the eclipse p2 repository with the Stardust eclipse plug-ins can be built. Run the following command replacing [build_tools_home] with the absolute path to your build.tools sub folder:

mvn clean install -f product/pom.xml -Pfull-build,force-overwrite,ipp-build -Dbuild.tools.home=[build_tools_home]

for instance:

mvn clean install -f product/pom.xml -Pforce-overwrite,ipp-build -Dbuild.tools.home=c:/stardustbuild/build.tools

This will trigger the build of the p2 repository. After the build has finished successful, you will find the repository in the sub folder :

stardust/repository/org.eclipse.stardust.modeling.repository/target/repository/

and zipped as an update site:

stardust/repository/org.eclipse.stardust.modeling.repository/target/org.eclipse.stardust.modeling.repository.zip

Binary Distribution

All Stardust source code has been submitted to the Eclipse git repository. A complete binary distribution requires libraries which are still pending approval by Eclipse legal, hence no binary distribution is available yet. One will be available for download form the project website as soon as the libraries have been approved.

Compliance

• The products libraries have been reviewed for license conflicts.
• Dependencies that did not comply with the Eclipse Public License (EPL) have been replaced
• The source has been submitted to the Eclipse foundation where it was reviewed with regards to intellectual property rights and licensing.
• The source was refactored. All package names were change to the eclipse package names.