Difference between revisions of "CBI"

From Eclipsepedia

Jump to: navigation, search
(Tycho)
(License Bundle)
 
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
The Eclipse Common Build Infrastructure (CBI) is an initiative combining technologies and practices for building Eclipse Software.
 
The Eclipse Common Build Infrastructure (CBI) is an initiative combining technologies and practices for building Eclipse Software.
 +
 +
==What is CBI==
 +
 +
The core of CBI today is Maven with the Tycho plugins. The Tycho plugins teach Maven how to build (and consume) Eclipse plugins and OSGi bundles. This enables building Eclipse projects with "maven clean install" just as one would build other Maven projects.
 +
 +
Common services such as the Jar signing facility, MacOS signing facility, and Windows signing facility are also included with CBI. Other tools and services may be included in the future as the need arises.
 +
 +
Over time mature templates and common pom.xml files will be provided that set common values finely honed with experience.
 +
 +
One might go so far as to include Git, Hudson, the build slaves, and Nexus (aka. the artifact repository & server side of Maven) as part of CBI since they are also common and crucial to builds.
 +
 +
Gerrit, Bugzilla, and the Downloads site are closely related. Some might consider them part of CBI as well.
 +
 +
 +
===Who is using it?===
 +
 +
There's a [http://wiki.eclipse.org/CBI/Projects list of projects] building with CBI available.
 +
 +
The Eclipse Foundation would like to have more than 50% of projects building with CBI by end of 2013.
  
 
==Initiative Goals==
 
==Initiative Goals==
Line 14: Line 33:
 
* Get all Eclipse projects building their software on Eclipse Foundation hardware.
 
* Get all Eclipse projects building their software on Eclipse Foundation hardware.
 
* Enable the [http://wiki.eclipse.org/EclipseLTS Long Term Support Program].
 
* Enable the [http://wiki.eclipse.org/EclipseLTS Long Term Support Program].
 +
* Make it easy for people to build custom Eclipse distributions.
  
  
Line 22: Line 42:
 
==Next meeting==
 
==Next meeting==
  
* Bi-weekly conference call, Tuesdays 10:00 to 11:00 Eastern timezone. [http://wiki.eclipse.org/CBI/Conference Conference bridge details]. Contact andrew dot ross at eclipse dot org if you would like to be added to the Calendar reminder.
+
See the [http://wiki.eclipse.org/CBI/Conference conference bridge details]. Contact andrew dot ross at eclipse dot org if you would like to be added to the Calendar reminder. The dates the upcoming calls are as follows:
* [http://wiki.eclipse.org/CBI/Code_Sprint_April_11_2012 Code Sprint #1] - in Ottawa, Canada
+
* November 15th, 9am EST
* Code Sprint #2 - in July, 2012
+
 
+
==GSoC==
+
 
+
There are opportunities for students interested in participating in Google Summer of Code. Please see our list of [http://wiki.eclipse.org/Google_Summer_of_Code_2012_Ideas project ideas and scan for CBI].
+
  
 
==Resources==
 
==Resources==
 
* mailing list [https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
 
* mailing list [https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
* [https://bugs.eclipse.org/bugs/buglist.cgi?action=wrap&product=CBI&list_id=38248 List of Bugs] (Product = CBI)
 
  
==Notable Implementations==
+
===Bugs===
* [[CBI/Eclipse Platform Build]] see the [[CBI/Eclipse Platform Build Roadmap]]
+
* [https://bugs.eclipse.org/bugs/buglist.cgi?action=wrap;product=CBI;version=1.0;list_id=2249872 CBI 1.0]
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?action=wrap;product=CBI;version=2.0;list_id=2249872 CBI 2.0]
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?action=wrap&product=CBI&list_id=38248 List of All Bugs] (Product = CBI)
 +
 
 +
==Tutorials, News, and other resources==
 +
* [http://www.vogella.com/articles/EclipseTycho/article.html Tycho tutorial by Lars Vogel]
 
* [http://www.fosslc.org/drupal/content/tycho-good-bad-and-ugly Video discussing JBoss tools use of Tycho]
 
* [http://www.fosslc.org/drupal/content/tycho-good-bad-and-ugly Video discussing JBoss tools use of Tycho]
 +
* [http://wiki.eclipse.org/CBI/Workshops Workshops being developed]
 +
* [http://www.vogella.com/blog/2012/10/08/building-eclipse-sdk-locally-with-maven/ Building Eclipse SDK locally with Maven]
 +
* [http://mickaelistria.wordpress.com/2012/10/08/sonar-at-eclipse-org/ Sonar at Eclipse.org !]
 +
* [http://youtu.be/KJUfLvXiTSw Tycho and CBI Adoption: Feedback from the trenches]
 +
* [http://www.bsiag.com/scout/?p=678 Eclipse Scout builds with CBI]
 +
 +
==Eclipse platform CBI build==
 +
* [http://wiki.eclipse.org/Platform-releng/Platform_Build Eclipse Platform Build based on CBI] see the [[CBI/Eclipse Platform Build Roadmap]]
  
 
==Preferred Build Technologies==
 
==Preferred Build Technologies==
Line 64: Line 91:
 
* [[Tycho/Packaging_Types|Packaging Types]]
 
* [[Tycho/Packaging_Types|Packaging Types]]
  
==Related Topics and Links==
+
===Nexus===
* [http://wiki.eclipse.org/EclipseLTS Long Term Support]
+
* [http://wiki.eclipse.org/Build_Technologies List of Build Technologies]
+
  
==Meeting Minutes==
+
[[Services/Nexus]]
* [http://wiki.eclipse.org/CBI/Jan10_2012 January 10, 2012]
+
* [http://wiki.eclipse.org/CBI/Jan24_2012 January 24, 2012]
+
* [http://wiki.eclipse.org/CBI/Feb7_2012 February 7, 2012]
+
* [http://wiki.eclipse.org/CBI/March6_2012 March 6, 2012]
+
* [http://wiki.eclipse.org/CBI/Mar20_2012 March 20, 2012]
+
  
==FAQ==
+
===Signing tool===
  
===What does the CBI build of the Eclipse platform do?===
+
* [http://git.eclipse.org/c/cbi/org.eclipse.cbi.maven.plugins.git/tree/README Maven plugins for signing artifacts]
 +
* [http://wiki.eclipse.org/IT_Infrastructure_Doc#Sign_my_plugins.2FZIP_files.3F On demand signing tool]
  
Answer: The CBI build of the Eclipse platform is intended to produce the same output as the PDE build, and thus facilitate packaging without noticeable change. The noticeable difference the CBI build of the platform makes is ease of use to build the platform. For example, the prototype has consistently demonstrated that a newcomer without prior experience can build the Eclipse platform with under 30 minutes of effort on a machine with a supported JDK & Maven.
+
==CBI License bundle==
  
 +
We offer a P2 repository containing the org.eclipse.license bundle which is located at:
  
===What is the link between CBI & LTS?===
+
    http://download.eclipse.org/cbi/updates/license/
  
Answer: The Long Term Support program is aimed at enabling organizations to support and maintain Eclipse software far into the future, for decades if needed. Part of the program enables maintenance committers working on behalf of the company to fix issues. Ensuring a very easy to use, very easy to maintain, and portable build was essential to the program. The fact that a build with these attributes also provides much benefit to the community was another good reason to do CBI.
+
This URL is a composite P2 repo containing the license bundle.
  
  
===Won't CBI be kept behind a firewall at Eclipse?===
+
If you are using Tycho you can add the p2 repo to the <repositories> section of your pom.xml file. Something similar to this:
  
Answer: No, the work done for CBI will be public and available and projects will be encouraged to leverage them. In the future, there may be some enhanced tools and features based on CBI designed to make Long Term Support (LTS) easier/more efficient/more effective. These might be available to members of the LTS working group only and enable a business model which supports the Eclipse Foundation.
+
<pre>
 +
    <repository>
 +
      <id>license-feature</id>
 +
      <url>http://download.eclipse.org/cbi/updates/license/</url>
 +
      <layout>p2</layout>
 +
    </repository>
 +
</pre>
  
  
===Will my project be forced to move to CBI?===
+
In any particular feature which you need the license you can use the usual feature.xml section:
  
Answer: No, there are no plans for forcing projects to use CBI. But if CBI develops the way we intend, you'll likely feel there's much good value to use it and decide to move to CBI on your own. Part of the benefit include the really easy to use & powerful build. Part of the benefit is that using CBI allows the Eclipse Foundation's release engineer to provide some assistance to ensure your project has a really good build. Another important part of the CBI initiative is a Continuous integration facility and build farm maintained by the Eclipse Foundation... so you don't need to create & maintain one yourself somewhere else.
+
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<feature
 +
      id="org.eclipse.help"
 +
      label="%featureName"
 +
      version="2.0.0.qualifier"
 +
      provider-name="%providerName"
 +
      plugin="org.eclipse.help.base"
 +
      license-feature="org.eclipse.license"
 +
      license-feature-version="1.0.0.qualifier">
 +
....
 +
</pre>
  
 +
==Related Topics and Links==
 +
* [http://wiki.eclipse.org/EclipseLTS Long Term Support]
 +
* [http://wiki.eclipse.org/Build_Technologies List of Build Technologies]
  
===Isn't this just yet-another-build system at Eclipse?===
+
==FAQ==
 +
 
 +
* See your [http://wiki.eclipse.org/CBI/FAQ Frequently Asked Question list]
 +
 
 +
==Meeting Minutes==
 +
* [http://wiki.eclipse.org/CBI/Jan10_2012 January 10, 2012]
 +
* [http://wiki.eclipse.org/CBI/Jan24_2012 January 24, 2012]
 +
* [http://wiki.eclipse.org/CBI/Feb7_2012 February 7, 2012]
 +
* [http://wiki.eclipse.org/CBI/March6_2012 March 6, 2012]
 +
* [http://wiki.eclipse.org/CBI/Mar20_2012 March 20, 2012]
 +
* [http://wiki.eclipse.org/CBI/Code_Sprint_April_11_2012 Code Sprint #1, April 11, 2012] - in Ottawa, Canada
 +
* [http://wiki.eclipse.org/CBI/Apr17_2012 April 17, 2012]
 +
* [http://wiki.eclipse.org/CBI/May1_2012 May 1, 2012]
 +
* [http://wiki.eclipse.org/CBI/May15_2012 May 15, 2012]
 +
* [http://wiki.eclipse.org/CBI/May29_2012 May 29, 2012]
 +
* [http://wiki.eclipse.org/CBI/June12_2012 June 12, 2012]
 +
* [http://wiki.eclipse.org/CBI/June26_2012 June 26, 2012]
 +
* [http://wiki.eclipse.org/CBI/July25_2012 July 25, 2012]
 +
* [http://wiki.eclipse.org/CBI/November15_2012 November 15, 2012]
 +
* [http://wiki.eclipse.org/CBI/January8_2013 January 8, 2013]
  
Answer: In truth, many of the technologies involved with CBI such as Maven, Tycho, Hydson, Git, etc. were already in use by a number of projects who consider them to be best of breed. In addition, they were/are being considered by others. Thus in a way, CBI is an evolutionary effort building on momentum in the community. Technologies such as Maven and Nexus (the artefact storage repository often used with Maven) are ubiquitous and very popular.
+
[[Category:CBI]]

Latest revision as of 09:33, 18 October 2013

The Eclipse Common Build Infrastructure (CBI) is an initiative combining technologies and practices for building Eclipse Software.

Contents

[edit] What is CBI

The core of CBI today is Maven with the Tycho plugins. The Tycho plugins teach Maven how to build (and consume) Eclipse plugins and OSGi bundles. This enables building Eclipse projects with "maven clean install" just as one would build other Maven projects.

Common services such as the Jar signing facility, MacOS signing facility, and Windows signing facility are also included with CBI. Other tools and services may be included in the future as the need arises.

Over time mature templates and common pom.xml files will be provided that set common values finely honed with experience.

One might go so far as to include Git, Hudson, the build slaves, and Nexus (aka. the artifact repository & server side of Maven) as part of CBI since they are also common and crucial to builds.

Gerrit, Bugzilla, and the Downloads site are closely related. Some might consider them part of CBI as well.


[edit] Who is using it?

There's a list of projects building with CBI available.

The Eclipse Foundation would like to have more than 50% of projects building with CBI by end of 2013.

[edit] Initiative Goals

[edit] Primary

  • Make it really easy to contribute Eclipse projects
    • Make it really easy to copy & modify source
    • Make it really easy to build
    • Make it really easy to test
    • Make it really easy to post a change for review
    • Make it really easy to sign software

[edit] Secondary

  • Get all Eclipse projects building their software on Eclipse Foundation hardware.
  • Enable the Long Term Support Program.
  • Make it easy for people to build custom Eclipse distributions.


There is a strong link between CBI and the Long Term Support Program which enables a marketplace of companies providing maintenance and support for Eclipse technologies for durations far beyond typical community support. Please NOTE: CBI features will be available to community.

It is our hope that this project develops an offering that is compelling so that many projects will move to use it.

[edit] Next meeting

See the conference bridge details. Contact andrew dot ross at eclipse dot org if you would like to be added to the Calendar reminder. The dates the upcoming calls are as follows:

  • November 15th, 9am EST

[edit] Resources

[edit] Bugs

[edit] Tutorials, News, and other resources

[edit] Eclipse platform CBI build

[edit] Preferred Build Technologies

[edit] Hudson

[edit] Maven

Maven 3.0 drives the builds. Projects are expected to provide standard Maven 3.0 POM files for their builds. The builds should be built in such a way that they can be run on the local workstation, or on the Eclipse build server. Note that builds can only be signed on the Eclipse build server.

[edit] Tycho

Tycho is focused on a Maven-centric, manifest-first approach to building Eclipse plug-ins, features, update sites, RCP applications and OSGi bundles.

Helpful links:

[edit] Nexus

Services/Nexus

[edit] Signing tool

[edit] CBI License bundle

We offer a P2 repository containing the org.eclipse.license bundle which is located at:

   http://download.eclipse.org/cbi/updates/license/

This URL is a composite P2 repo containing the license bundle.


If you are using Tycho you can add the p2 repo to the <repositories> section of your pom.xml file. Something similar to this:

    <repository>
      <id>license-feature</id>
      <url>http://download.eclipse.org/cbi/updates/license/</url>
      <layout>p2</layout>
    </repository>


In any particular feature which you need the license you can use the usual feature.xml section:

<?xml version="1.0" encoding="UTF-8"?>
<feature
      id="org.eclipse.help"
      label="%featureName"
      version="2.0.0.qualifier"
      provider-name="%providerName"
      plugin="org.eclipse.help.base"
      license-feature="org.eclipse.license"
      license-feature-version="1.0.0.qualifier"> 
....

[edit] Related Topics and Links

[edit] FAQ

[edit] Meeting Minutes