Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/HowTo/How to integrate new bundle into build process"

(1. Include new plug-in into org.eclipse.eilf.feature)
m
 
(23 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<table style="background-color:#d8e4f1">
+
This page describse how to integrate your [[SMILA/Documentation/HowTo/Create_a_bundle_(plug-in)|own new bundle (plug-in)]] into the SMILA build process.
<tr><td>
+
  
'''Useful Information'''
+
=== '''Include new plug-in into org.eclipse.smila.feature''' ===
  
From today (build process depends on make.xml) you don´t have to modify the build file (make.xml) anymore.
+
To include your plug-in:
The make.xml file includes all bundles,those are located under the local trunk folder (e.g. EILF).
+
If you don´t want to include your new bundle into the build process, the bundle has to excluded explicit in the make.xml.
+
  
For further information see: [[SMILA/Development_Guidelines/Introduction to make.xml|Introduction to make.xml]].
+
# Open the <tt>feature.xml</tt> file of the project <tt>org.eclipse.smila.feature</tt> in the Feature Manifest Editor.
 +
# Switch to the ''Plug-ins'' page and add the bundle to the ''Plug-ins and Fragments'' list. You don't have to adapt the Plug-in Details. <br> [[Image:EilfFeature.png|600 px]]
  
 +
<br>
 +
<table style="background-color:#d8e4f1">
 +
<tr><td>
 +
'''Useful Information'''
 +
You don't have to modify the build file (<tt>make.xml</tt>) to include your bundle in the build process.
 +
The <tt>make.xml</tt> file includes all SMILA bundles located under the local trunk folder, along with those bundles whose names match its <patternset> elements (com.*, net.* and so on). If you get an error such as "Unable to find bundle xxx", it's probably because it is not matched by <tt>make.xml</tt> and it is not copied to the build folder. If you don't want to include your new bundle into the build process, the bundle has to be excluded explicitly in <tt>make.xml</tt>. For further information see: [[SMILA/Development_Guidelines/Introduction to make.xml|Introduction to make.xml]].
 
</td></tr>
 
</td></tr>
 
</table>
 
</table>
After you create your new bundle and commit it to svn you have to performe the following step to integrate your new bundle (plug-in) into build process (Bamboo):
 
  
=== '''1. Include new plug-in into org.eclipse.smila.feature''' ===
+
For information on how to build the SMILA distribution see: ''[[SMILA/Development_Guidelines/Howto_build_a_SMILA-Distribution|How to build a SMILA distribution]]''.
  
[[Image:EilfFeature.png]]
+
=== '''Optional step: Generate Source Bundle '''  ===
  
 +
The build process can also generate an additional source bundle for a new bundle so that debugging is easier when SMILA is used as a target platform (see [[SMILA/Development Guidelines/How to set up integration environment|How to set up the integration environment]]). This needs some manual modification of the files of the feature that includes the bundle:
  
'''For further information see: [[SMILA/Development_Guidelines/Build and Test Eclipse Product|Build and Test Eclipse Product]]'''
+
* In <tt>org.eclipse.smila.feature/build.properties</tt> add a line like this using the bundle name of your new bundle:
 +
<div style="margin-left: 1em;">
 +
<source lang="text">
 +
generate.plugin@org.eclipse.smila.sample.pipelet.source = org.eclipse.smila.sample.pipelet
 +
</source>
 +
</div>
 +
* In <tt>org.eclipse.smila.feature/feature.xml</tt> add an entry like this to include the source bundle in the feature:
 +
<div style="margin-left: 1em;">
 +
<source lang="xml">
 +
  <plugin
 +
        id="org.eclipse.smila.sample.pipelet.source"
 +
        download-size="0"
 +
        install-size="0"
 +
        version="0.0.0"
 +
        unpack="false"/>
 +
</source>
 +
</div>
 +
:Ignore the warning stating that the bundle cannot be resolved. It is generated automatically at build time.
 +
* In your bundle, be sure to add at least the <tt>META-INF</tt> directory, the <tt>about</tt> files and the <tt>build.properties</tt> to the build configuration of the source build. Add additional files (schemas, sample configs, etc) as appropriate. Do NOT add the <tt>code/src</tt> or other source directories, this is done automatically by the build process: <br> [[Image:SMILA-bundle-source-build-properties.png|600 px]]
 +
[[Category: SMILA]]

Latest revision as of 08:12, 25 January 2012

This page describse how to integrate your own new bundle (plug-in) into the SMILA build process.

Include new plug-in into org.eclipse.smila.feature

To include your plug-in:

  1. Open the feature.xml file of the project org.eclipse.smila.feature in the Feature Manifest Editor.
  2. Switch to the Plug-ins page and add the bundle to the Plug-ins and Fragments list. You don't have to adapt the Plug-in Details.
    EilfFeature.png


Useful Information You don't have to modify the build file (make.xml) to include your bundle in the build process. The make.xml file includes all SMILA bundles located under the local trunk folder, along with those bundles whose names match its <patternset> elements (com.*, net.* and so on). If you get an error such as "Unable to find bundle xxx", it's probably because it is not matched by make.xml and it is not copied to the build folder. If you don't want to include your new bundle into the build process, the bundle has to be excluded explicitly in make.xml. For further information see: Introduction to make.xml.

For information on how to build the SMILA distribution see: How to build a SMILA distribution.

Optional step: Generate Source Bundle

The build process can also generate an additional source bundle for a new bundle so that debugging is easier when SMILA is used as a target platform (see How to set up the integration environment). This needs some manual modification of the files of the feature that includes the bundle:

  • In org.eclipse.smila.feature/build.properties add a line like this using the bundle name of your new bundle:
generate.plugin@org.eclipse.smila.sample.pipelet.source = org.eclipse.smila.sample.pipelet
  • In org.eclipse.smila.feature/feature.xml add an entry like this to include the source bundle in the feature:
   <plugin
         id="org.eclipse.smila.sample.pipelet.source"
         download-size="0"
         install-size="0"
         version="0.0.0"
         unpack="false"/>
Ignore the warning stating that the bundle cannot be resolved. It is generated automatically at build time.
  • In your bundle, be sure to add at least the META-INF directory, the about files and the build.properties to the build configuration of the source build. Add additional files (schemas, sample configs, etc) as appropriate. Do NOT add the code/src or other source directories, this is done automatically by the build process:
    SMILA-bundle-source-build-properties.png