Jump to: navigation, search

Difference between revisions of "CBI"

(Next meeting)
(Signing tool)
 
(20 intermediate revisions by 7 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.
  
==Initiative Goals==
+
==What is CBI==
  
===Primary===
+
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.
 +
 
 +
==Initiative Goals==
 +
Primary goals are:
 
* Make it really easy to contribute Eclipse projects
 
* Make it really easy to contribute Eclipse projects
 
** Make it really easy to copy & modify source
 
** Make it really easy to copy & modify source
Line 11: Line 22:
 
** Make it really easy to sign software
 
** Make it really easy to sign software
  
===Secondary===
+
Secondary goals are:
 
* 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.
  
 
There is a strong link between CBI and the [http://wiki.eclipse.org/EclipseLTS 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.
 
There is a strong link between CBI and the [http://wiki.eclipse.org/EclipseLTS 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.
Line 20: Line 31:
 
It is our hope that this project develops an offering that is compelling so that many projects will move to use it.
 
It is our hope that this project develops an offering that is compelling so that many projects will move to use it.
  
==Next meeting==
+
==Who is using it?==
  
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:
+
There's a [http://wiki.eclipse.org/CBI/Projects list of projects] building with CBI available.  
* November 15th, 9am EST
+
The Eclipse Foundation would like to have more than 50% of projects building with CBI by end of 2013.
  
==Resources==
+
[http://wiki.eclipse.org/Platform-releng/Platform_Build Eclipse Platform Build is based on CBI] see the [[CBI/Eclipse Platform Build Roadmap]]
* mailing list [https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
+
 
+
===Bugs===
+
* [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://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 !]
+
 
+
==Eclipse platform CBI build==
+
* [[CBI/Eclipse Platform Build]] see the [[CBI/Eclipse Platform Build Roadmap]]
+
  
 
==Preferred Build Technologies==
 
==Preferred Build Technologies==
Line 47: Line 42:
 
===Hudson===
 
===Hudson===
  
* The Eclipse [http://hudson.eclipse.org Hudson instance]; and
+
* The Eclipse [http://hudson.eclipse.org Hudson instance], [[Hudson | Hudson/HIPP docs]]; and
 
* Hudson projects using [https://hudson.eclipse.org/hudson/view/Tycho%20+%20Maven/ Maven and Tycho].
 
* Hudson projects using [https://hudson.eclipse.org/hudson/view/Tycho%20+%20Maven/ Maven and Tycho].
  
Line 68: Line 63:
 
* [[Tycho/Reference_Card|Reference Card]]
 
* [[Tycho/Reference_Card|Reference Card]]
 
* [[Tycho/Packaging_Types|Packaging Types]]
 
* [[Tycho/Packaging_Types|Packaging Types]]
 +
 +
=== p2 Repo checks ===
 +
 +
It's highly recommended that any Eclipse.org project runs frequently, and maybe even systematically, the [[CBI/p2repoAnalyzers/Repo Reports|p2 repo analyzer]] to make sure it conforms to some requirements of being a nice citizen in the Eclipse.org world.
 +
 +
===Nexus===
 +
 +
[[Services/Nexus]]
  
 
===Signing tool===
 
===Signing tool===
  
[http://wiki.eclipse.org/IT_Infrastructure_Doc#Sign_my_plugins.2FZIP_files.3F On demand signing tool]
+
* [http://git.eclipse.org/c/cbi/org.eclipse.cbi.git/tree/maven-plugins/README.md Maven plugins for signing artifacts]
 +
* [[IT_Infrastructure_Doc#Sign_my_plugins.2FZIP_files.3F|On demand signing tool]]
 +
 
 +
== Deliverables ==
 +
 
 +
Additionally to recommendation and infrastructure, the CBI also produces pieces of software that are meant to be commonly used by all Eclipse.org projects.
 +
 
 +
===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:
 +
 
 +
<source lang="xml">
 +
    <repository>
 +
      <id>license-feature</id>
 +
      <url>http://download.eclipse.org/cbi/updates/license/</url>
 +
      <layout>p2</layout>
 +
    </repository>
 +
</source>
 +
 
 +
In any particular feature which you need the license you can use the usual feature.xml section:
 +
 
 +
<source lang="xml">
 +
<?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"/>
 +
....
 +
</source>
 +
 
 +
===Signing tool===
 +
 
 +
* [http://git.eclipse.org/c/cbi/org.eclipse.cbi.maven.plugins.git/about/ Maven plugins for signing artifacts]
 +
* [[IT_Infrastructure_Doc#Sign_my_plugins.2FZIP_files.3F|On demand signing tool]]
 +
 
 +
=== p2 repo checks ===
 +
 
 +
A set of "tests" which create reports or can be ran as unit tests that check to correctness of p2 repositories. That is partially just "correctness" in general (such as, that jars are signed, etc.) but more so that repositories conform to the requirements of the Eclipse Simultaneous release (such as, that jars have correct "Provider names", licenses, etc.). For more information, see See [[CBI/p2repoAnalyzers/Repo Reports]].
 +
 
 +
=== p2 repo aggregator ===
 +
 
 +
A tool to combine several p2 repositories. Among other things, it makes sure they all have consistent constraints (that is, can be "installed together") unlike a raw p2 mirror task. For more information see [[CBI/aggregator/manual]].
  
 
==Related Topics and Links==
 
==Related Topics and Links==
* [http://wiki.eclipse.org/EclipseLTS Long Term Support]
+
* [[EclipseLTS|Long Term Support]]
* [http://wiki.eclipse.org/Build_Technologies List of Build Technologies]
+
* [[Build_Technologies List of Build Technologies]]
  
==FAQ==
+
==Resources==
 +
=== Mailing-list ===
 +
[https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
  
* See your [http://wiki.eclipse.org/CBI/FAQ Frequently Asked Question list]
+
=== FAQ ===
 +
 
 +
* See your [[CBI/FAQ|Frequently Asked Question list]]
 +
 
 +
===Bugs===
 +
* [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://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]
 +
 
 +
 
 +
==Meetings==
 +
 
 +
=== Next Meeting ===
 +
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:
 +
* November 15th, 9am EST
  
==Meeting Minutes==
+
===Meeting Minutes===
 
* [http://wiki.eclipse.org/CBI/Jan10_2012 January 10, 2012]
 
* [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/Jan24_2012 January 24, 2012]
Line 95: Line 175:
 
* [http://wiki.eclipse.org/CBI/June26_2012 June 26, 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/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]
 +
 +
[[Category:CBI]]

Latest revision as of 06:28, 21 November 2016

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.

Initiative Goals

Primary goals are:

  • 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

Secondary goals are:

  • 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.

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.

Eclipse Platform Build is based on CBI see the CBI/Eclipse Platform Build Roadmap

Preferred Build Technologies

Hudson

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.

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:

p2 Repo checks

It's highly recommended that any Eclipse.org project runs frequently, and maybe even systematically, the p2 repo analyzer to make sure it conforms to some requirements of being a nice citizen in the Eclipse.org world.

Nexus

Services/Nexus

Signing tool

Deliverables

Additionally to recommendation and infrastructure, the CBI also produces pieces of software that are meant to be commonly used by all Eclipse.org projects.

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"/> 
....

Signing tool

p2 repo checks

A set of "tests" which create reports or can be ran as unit tests that check to correctness of p2 repositories. That is partially just "correctness" in general (such as, that jars are signed, etc.) but more so that repositories conform to the requirements of the Eclipse Simultaneous release (such as, that jars have correct "Provider names", licenses, etc.). For more information, see See CBI/p2repoAnalyzers/Repo Reports.

p2 repo aggregator

A tool to combine several p2 repositories. Among other things, it makes sure they all have consistent constraints (that is, can be "installed together") unlike a raw p2 mirror task. For more information see CBI/aggregator/manual.

Related Topics and Links

Resources

Mailing-list

cbi-dev

FAQ

Bugs

Tutorials, News, and other resources


Meetings

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

Meeting Minutes