Skip to main content
Jump to: navigation, search

Difference between revisions of "Stardust/Source Code"

m (STP/Stardust/Source Code moved to Stardust/Source Code: Stardust is not STP)
(Running the Build)
 
(80 intermediate revisions by 6 users not shown)
Line 1: Line 1:
= Stardust Source Code Access =
+
= Browsing the Source Code =
  
Currently the publishing of the source code is still in progress. A couple of steps need to be completed before it can be published in the eclipse code repository and the team is very committed to completing those asap. Some example are:
+
For initial quick browsing of the source code please go to http://git.eclipse.org/c/?q=stardust.
  
*The products libraries have to be reviewed for license conflicts (completed)
+
= Overview  =
*Dependencies that do not comply with the [http://www.eclipse.org/legal/epl-v10.html Eclipe Public License] (EPL) have to be replaced in the source code (completed)
+
*The source has to be submitted to the Eclipse foundation where it is reviewed with regards to intellectual property rights and licensing (in progress)
+
*The source needs to be refactored. All package names have to be change to the new eclipse package names before to code is allowed to go into the repository (in progress)
+
  
Please check the [http://www.eclipse.org/stardust/ project website] regularly if you want to stay updated on the progress.  
+
This documentation covers the local build of stardust. You can use the command line or build directly in the Eclipse IDE.  
  
You may also want to subscribe to the [https://dev.eclipse.org/mailman/listinfo/stardust-dev Stardust Developer mailing list] to be notified when the source is completely submitted to the eclipse repository.
+
== Command Line Build  ==
 +
 
 +
=== Installing Git  ===
 +
 
 +
To checkout the source code you need to install git first. You have different options:
 +
 
 +
*[http://git-scm.com/ git scm] installs a minimal environment to run Git. It comes with a Bash,a Perl interpreter, the Git executable plus dependencies.
 +
*[http://msysgit.github.io/ msysgit] installs a build environment for Git on Windows. It includes git scm. After installtion you can open a git shell to run git commands (git bash or git-cmd.bat).<br>
 +
 
 +
=== Clone git Repositories  ===
 +
 
 +
*Create a new folder, e.g. '''C:\\stardust''', and open a git shell there. (bash on Linux/Win or git-cmd.bat on Win)
 +
*Copy the following commands to a file named '''cloneStardust.cmd''' or '''cloneStardust.sh''' file.
 +
*Save it to the '''stardust''' folder and execute it.
 +
<pre>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.components.git components
 +
git clone http://git.eclipse.org/gitroot/stardust/org.eclipse.stardust.deploy.jee.git deploy.jee
 +
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.examples.git examples
 +
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.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.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.repository.git repository
 +
git clone http://git.eclipse.org/gitroot/stardust/org.eclipse.stardust.ui.common.git ui.common
 +
git clone http://git.eclipse.org/gitroot/stardust/org.eclipse.stardust.ui.web.git ui.web
 +
 
 +
</pre>
 +
<br> If you run git clone behind a HTTP proxy specify proxy details first.
 +
<pre>git config --global http.proxy http://&lt;user&gt;:&lt;password&gt;@proxy:port</pre>
 +
Now you have the default checkout which is the '''master''' branch.
 +
 
 +
Following branches are available:
 +
 
 +
'''Please find in [[Stardust/Source Code/Branch strategy|Branch strategy]] explained which branch to use.'''
 +
 
 +
For more details on the differences between stardust versions, please look at the [http://projects.eclipse.org/projects/soa.stardust project website].
 +
 
 +
If you like to clone a specific branch add '''"-b &lt;branch-name&gt;"''' to the git command. To work on a stable source please use release tags as checkout. We have a help script (linux) to do git commands on all stardust repositories:
 +
<pre>cd &lt;root-of-your-stardust-checkout&gt;
 +
build.tools\bin\git-all.sh checkout v1.0.0.20130612-0325-R</pre>
 +
 
 +
We tag every milestone and release build. See git for details.
 +
 
 +
=== Build Stardust  ===
 +
 
 +
==== Prerequisites  ====
 +
 
 +
*JDK - we suggest Java 1.7
 +
*[http://ant.apache.org/ Apache ANT] - we suggest Ant 1.8
 +
*[http://maven.apache.org/download.html Apache Maven] - we suggest Maven 3.2.5
 +
 
 +
==== Running the Build  ====
 +
 
 +
To maybe cover the different build configurations in branches, we have a '''readme.md''' available in the source tree. Please follow the steps described in [http://git.eclipse.org/c/stardust/org.eclipse.stardust.product.git/tree/README.md?h=release/4.1.0 readme.md] residing in '''product''' folder.
 +
 
 +
===== Version Qualifier =====
 +
 
 +
The concrete value of the .qualifier version part may be set to a define value by appending "-DforceContextQualifer=<qualifier value>".
 +
Please note, that if you do not provide an explicit Stardust version and qualifier, build artifacts will use the default build version (which is currently 9.9.9-SNAPSHOT). You should check startust/org.eclipse.stardust/org.eclipse.stardust-parent/pom.xml for the ipp.version, which should equal the version you are
 +
using in your overall build.
 +
 
 +
==== Where to go from here?<br>  ====
 +
 
 +
Now you can use the build result, '''a local eclipse update site''',&nbsp;to install Stardust. Follow the instructions in the section [[Stardust/Knowledge Base/Getting Started/Installation#Local_Eclipse_Update_Site|Local Eclipse Update Site (offline)]]<br>
 +
 
 +
If you like to consume our '''archetypes''', e.g. tomcat7 web archive, via maven please find documentation here: [http://wiki.eclipse.org/Stardust/Knowledge_Base/Build_and_Change_Management/Maven/Basic_Setup Maven - Basic Setup]
 +
 
 +
Next check out the resource in the [[Stardust/Knowledge Base|Stardust Knowledge Base]], especially the [[Stardust/Knowledge Base#Getting_Started|Getting Started]] section. You may also want to check out the [http://www.eclipse.org/forums/index.php?t=thread&frm_id=225 Forum] to post questions or just exchange thoughts with the community.<br>
 +
To access the '''online help''' please consult [http://help.eclipse.org/topic/org.eclipse.stardust.docs.dev/html/toc.html help.eclipse.org]
 +
 
 +
==== Troubleshooting<br>  ====
 +
 
 +
If you experience any problems downloading the source code or building Stardust then please contact us via the [http://www.eclipse.org/forums/index.php?t=thread&frm_id=225 Forum].<br>
 +
 
 +
===== Errors fetching Dependencies<br>  =====
 +
 
 +
If you encounter errors during the build that indicate <u>missing dependencies</u> which could not be fetched from the repositories then try cleaning the ivy cache folder .ivy in your <span style="font-style: italic;">user.</span>''home'' (e.g. C:\Users\your.name\.ivy, if it exists) and the maven repository (check settings.xml in ''M2_HOME''/etc and/or ''user.home''/.m2 to determine the location).<br>
 +
 
 +
If your are using <u>Maven 3.0.4 behind a proxy</u> please see [[Stardust/Knowledge Base/Build and Change Management/Maven/Basic Setup#Troubleshooting|here]] on how to fix the issue.

Latest revision as of 12:14, 21 December 2016

Browsing the Source Code

For initial quick browsing of the source code please go to http://git.eclipse.org/c/?q=stardust.

Overview

This documentation covers the local build of stardust. You can use the command line or build directly in the Eclipse IDE.

Command Line Build

Installing Git

To checkout the source code you need to install git first. You have different options:

  • git scm installs a minimal environment to run Git. It comes with a Bash,a Perl interpreter, the Git executable plus dependencies.
  • msysgit installs a build environment for Git on Windows. It includes git scm. After installtion you can open a git shell to run git commands (git bash or git-cmd.bat).

Clone git Repositories

  • Create a new folder, e.g. C:\\stardust, and open a git shell there. (bash on Linux/Win or git-cmd.bat on Win)
  • Copy the following commands to a file named cloneStardust.cmd or cloneStardust.sh file.
  • Save it to the stardust folder and execute it.
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.components.git components
git clone http://git.eclipse.org/gitroot/stardust/org.eclipse.stardust.deploy.jee.git deploy.jee
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.examples.git examples
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.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.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.repository.git repository
git clone http://git.eclipse.org/gitroot/stardust/org.eclipse.stardust.ui.common.git ui.common
git clone http://git.eclipse.org/gitroot/stardust/org.eclipse.stardust.ui.web.git ui.web


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

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

Now you have the default checkout which is the master branch.

Following branches are available:

Please find in Branch strategy explained which branch to use.

For more details on the differences between stardust versions, please look at the project website.

If you like to clone a specific branch add "-b <branch-name>" to the git command. To work on a stable source please use release tags as checkout. We have a help script (linux) to do git commands on all stardust repositories:

cd <root-of-your-stardust-checkout>
build.tools\bin\git-all.sh checkout v1.0.0.20130612-0325-R

We tag every milestone and release build. See git for details.

Build Stardust

Prerequisites

Running the Build

To maybe cover the different build configurations in branches, we have a readme.md available in the source tree. Please follow the steps described in readme.md residing in product folder.

Version Qualifier

The concrete value of the .qualifier version part may be set to a define value by appending "-DforceContextQualifer=<qualifier value>". Please note, that if you do not provide an explicit Stardust version and qualifier, build artifacts will use the default build version (which is currently 9.9.9-SNAPSHOT). You should check startust/org.eclipse.stardust/org.eclipse.stardust-parent/pom.xml for the ipp.version, which should equal the version you are using in your overall build.

Where to go from here?

Now you can use the build result, a local eclipse update site, to install Stardust. Follow the instructions in the section Local Eclipse Update Site (offline)

If you like to consume our archetypes, e.g. tomcat7 web archive, via maven please find documentation here: Maven - Basic Setup

Next check out the resource in the Stardust Knowledge Base, especially the Getting Started section. You may also want to check out the Forum to post questions or just exchange thoughts with the community.
To access the online help please consult help.eclipse.org

Troubleshooting

If you experience any problems downloading the source code or building Stardust then please contact us via the Forum.

Errors fetching Dependencies

If you encounter errors during the build that indicate missing dependencies which could not be fetched from the repositories then try cleaning the ivy cache folder .ivy in your user.home (e.g. C:\Users\your.name\.ivy, if it exists) and the maven repository (check settings.xml in M2_HOME/etc and/or user.home/.m2 to determine the location).

If your are using Maven 3.0.4 behind a proxy please see here on how to fix the issue.

Back to the top