Difference between revisions of "Libra/Getting Started"
|Line 21:||Line 21:|
= Obtaining Sources =
= Obtaining Sources =
Revision as of 06:02, 1 August 2011
- 1 Getting Started
- 2 Obtaining Sources
- 3 Build Infrastructure
- 4 Proposing and Committing a Patch
- 5 Send us feedback
Installation and Use
The update site contains:
- OSGi Bundle Facet feature that introduces:
- A new facet OSGi Bundle for Dynamic Web, JPA and Utility projects.
- Wizard for converting WTP standard projects to OSGi Enterprise bundle projects:
- Dynamic Web projects to Web Application Bundle projects
- JPA projects to Persistent Bundle projects
- Utility projects and simple Java projects to OSGi Bundle projects
- Both options modify project's MANIFEST.MF in order to become a valid OSGi bundle.
The facet may be enabled during the project creation or after that from the Properties page of the project. The wizard is available from project's context menu Configure > Convert to OSGi Bundle Projects...
Note that you may need to adjust your target platform accordingly.
- WAR Products feature which provides WAR deployment for Equinox based applications
Create new Web Application Bundle
- Call the New Dymanic Web Project wizard: New > Project... > Web > Dynamic Web Project
- Enter the necessary project information like Project name, Target runtime, etc.
- Add the OSGi Bundle facet in the Configuration:
- Click on the Modify... button in the Configuration group.
- Choose the OSGi Bundle facet in the Project Facets dialog and click OK.
- Click Finish to create the Web Application Bundle project.
You can find the sources available in Git repository
In order to synchronize them locally, you may use the EGit step-by-step procedure.
The EGit/User Guide provides detailed instruction how to work with EGit.
- Start your Eclipse IDE and navigate to Help->Install New Software->Add...
- Enter the software update site 
- Select the Eclipse EGit (Incubation) and Eclipse JGit (Incubation) and choose Next> to finish the installation.
During the installation you will be asked to accept the License Agreements.
To identify yourself, follow these instructions these instructions
Setting up the Home Directory on Windows
To set up the HOME directory, go through these steps
Configuring SSH in Eclipse
To configure ssh, proceed as follows.
Clone Git Repository
- Open the Git Repository Exploring perspective and in the Git Repositories view choose the Clone a Git Repository toolbar button
- In the URI field of the opened Clone Git Repository wizard enter the URI of the libra git repository:  and choose Next
- Select the added repository and from its context menu choose Import Projects...
- Expand the repository tree to Remote Tracking level, select the remote branch origin/master and from its context menu choose Create Branch... to create a new local branch
To keep the sources up to date you have to pull the new changes from the upstream branch.
The build is based on Maven (at least 3.0.0) and Tycho, executed on the Hudson server, hosted at Eclipse Foundation.
There are two Hudson jobs available for Libra:
Maven Build Sequence
Complete build sequence for a clean build (assuming $M2_HOME/bin is on the path and local Maven repository at ~/.m2/repository):
[~/org.eclipse.libra/development/org.eclipse.libra.releng] $ mvn clean install
Note that you may need to configure your proxy settings
Proposing and Committing a Patch
The patch file contains a description of changes of a set of resources which can be automatically applied to another eclipse workspace or git repository. If you want to propose or commit a patch you need to know that the Eclipse update hook will examine the Committer's entries of an incoming push. All the committer's entries have to be made by the committer performing the push, otherwise the push will fail. Furthermore, your committer ID, or the committer e-mail address registered with your committer account at the Eclipse Foundation must be present in the Committer Email record. For more information on that restriction see: this page.
Proposing a Patch
If you want commit a change on a local feature or bugfix branch and then to export this change into a patch file, follow the steps below:
- Open a bug
- Specify the bug component (General; OSGi Facet or WAR)
- Complete the fields about the product version, bug severity, type of your hardware, operating systems and write a summary and description of the patch
- Open the History view of your Eclipse IDE and choose Create Patch... (The patch file will contain the difference between the commit and its parent in the history view. Note that the filter of the history view applies also for patch creation.)
- Start the Patch Wizard, select the location of the patch and choose Next (The name of the patch file is created from the first line of the commit message.)
- Change the patch format, if necessary.
- Attach the patch created to the bug
- Submit the bug
Committing a Patch
To commit a patch, proceed as follows:
- Apply the proposed patch using the Patch Wizard
- Test the patch
- Commit the patch
- Setup push configuration with the following push URL:
- Push the patch and see its change number in order to be able to inspect it
Reproducing a Build to a Certain Change List
Fetch to the specific change and build with Maven as described above.