Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Orbit/Adding Bundles to Orbit"

(Migrated to GitHub)
 
(80 intermediate revisions by 19 users not shown)
Line 1: Line 1:
== Moving an existing bundle to Orbit ==
+
{{warning|Note: The contents of this page has been migrated. Please see https://github.com/eclipse/orbit/blob/master/Add-bundle.md for current information, or page history for historical versions. }}
Taking a library that is already bundled in another Eclipse project and adding it to Orbit is quite straightforward.
+
# In your workspace, create a project with the desired name (see [[Bundle Naming]]).  For this example we'll use com.example.foo.
+
# In the project, create a readme.txt file that alerts users to the fact that the real content of the project is maintained in CVS branches.  Something like <pre><nowiki>Work in this project happens in various branches according to the
+
version of the library being maintained. For example, if you are
+
looking for javax.servlet version 2.3, check out the v2_3 branch
+
of the javax.servlet project.</nowiki></pre>
+
# Share the project into the Orbit repository using the '''Team > Share Project...''' wizard.  There select '''CVS''' then the "dev.eclipse.org/cvsroot/tools repository".  In the following page, choose '''Use specified module name''' and enter "org.eclipse.orbit/com.example.foo" (remember to fill-in your bundle name). Finish off the wizard steps.
+
# Since all real content in Orbit is maintained in branches, immediately create a branch using the '''Team > Branch...''' wizard.  You will be asked to enter a branch name. The typical pattern for that is "v<version number>" where the version number is that which was assigned by the original library producers with the '.' (period) characters replaced with '_' (underscore) characters.  So a library whose version is 2.3 would go in the v2_3 branch.  Ensure that the "Work with this branch" option is selected and and finish off the wizard.
+
# Delete the readme.txt file
+
# Check out the existing version of the library using '''Team > Check Out As...''' wizard from the repository navigator.  Pick any name you like for the new project.  For example, com.example.foo.old helps keep things clear.  This project will only be in your workspace for a few minutes
+
# Once the original project is checked out, copy and paste all content from the old project into the project you created at the beginning of these steps and delete the old project.
+
# Commit the changes to the new project (e.g., com.example.foo) to create an exact copy of the original bundle project in a branch in the Orbit repository.
+
 
+
== Adding a library for the first time ==
+
TBD
+
 
+
== Adding a library that is already a bundle ==
+
TBD
+

Latest revision as of 12:35, 3 April 2023

Warning2.png
Note: The contents of this page has been migrated. Please see https://github.com/eclipse/orbit/blob/master/Add-bundle.md for current information, or page history for historical versions.

Back to the top