Details for Uploading Main Rodin Update Site

Since April 5th, 2012, the Rodin update site has the newer p2 format. From a release engineer point of view, the main change is that instead of uploading 'site.xml' to the rodin web space, you will just commit 'content.jar' and 'artifacts.jar' to SVN. This page explains how to generate these two files. If you're interested in internal details, you can take a look at How we set up the p2 update site on SourceForge.

Using site.xml

Even though 'site.xml' is no more present on the remote update site, it can be used locally to publish new features (or new versions of existing features).

1. make sure your workspace copy of the plugin project org.rodinp.updateSite is synchronised with the SVN repository.
2. open 'site.xml' with the Site Manifest Editor
3. add your feature to the relevant category (no need to give artifact url)
4. click 'Build': 'content.jar' and 'artifacts.jar' get updated, 'features' and 'plugins' directories are created (do NOT click 'Build All', it would overwrite the update site !)
5. test locally, using org.rodinp.updateSite as local update site; in particular, check that other plug-ins on the update site are still listed
6. upload the jars generated by the build as usual in your plugin's area on SourceForge FRS
7. test remotely by uploading 'content.jar' and 'artifacts.jar' to /home/project-web/rodin-b-sharp/htdocs/test-updates on the rodin web space, and using 'http://rodin-b-sharp.sourceforge.net/test-updates' as remote update site (see #Remote test)
8. commit 'content.jar' and 'artifacts.jar' to SVN: it actually updates the Rodin Update Site itself
9. test using the standard Rodin Update Site (you may need to reload it)

So 'site.xml' is no more uploaded nor committed to SVN, it is really just there to help working with 'content.jar' and 'artifacts.jar'. In particular, if for some reason you want to commit it nevertheless, take care not to commit the post 'Build' version, as it mixes everything up.

Externally built feature

That's the harder way to proceed. If you are using scripts to build your feature (that is, without a running eclipse interface):

1. ensure that your build scripts produce a repository (like 'buildRepo')
2. categorize the repository (see below)
3. launch the 'publishFeature.xml' ant script in org.rodinp.updateSite on the categorized repository (modifying the 'featureRepo' property in the launch config) to update 'content.jar' and 'artifacts.jar'.

Messages like

  [p2.mirror] Problems resolving provisioning plan.
  [p2.mirror] Unable to satisfy dependency from <my plugin> to bundle org.eventb.ui 0.0.0.

are normal, it just indicates that the repository does not contain core bundles.

From this point, continue the same as with 'site.xml', from 'test locally' on.

Categorizing a build repository

Build repositories are not categorized by default. To assign a built feature a category, we have to use the Category Publisher:

1. copy the build repository somewhere, we'll call that somewhere $REPO (it ensures you can relaunch categorization if something goes wrong, without rebuilding your feature)
2. write a category file
3. run the Category Publisher

To make things concrete, here are sample files for categorizing the B2LaTeX plug-in:

category.xml:

<?xml version="1.0" encoding="UTF-8"?> 
<site> 
  <feature id="ac.soton.eventb.latex.feature"> 
    <category name="Utilities"/> 
  </feature> 
  <category-def name="Utilities" label="Utilities"/> 
</site> 

catPub.sh:

JAVA_HOME=/usr/lib/jvm/java-6-sun/jre 
ECLIPSE_HOME=/path/to/eclipse
REPO=/path/to/buildRepo/copy 
CAT_FOLDER=/path/to/category/folder

$JAVA_HOME/bin/java \ 
       -jar $ECLIPSE_HOME/plugins/org.eclipse.equinox.launcher_*.jar \ 
       -application org.eclipse.equinox.p2.publisher.CategoryPublisher \ 
       -metadataRepository file:/$REPO \ 
       -categoryDefinition file:/$CAT_FOLDER/category.xml

Remote test

Copy 'content.jar' and 'artifacts.jar' from your eclipse workspace to you user home directory (this just makes it easier to locate the file from the terminal command line since the user home directory is the default local directory in Terminal) Open the Terminal utility and enter the following commands replacing <sourceforgeusername> and <sourceforgepassword>:

Last login: Tue May 17 21:22:29 on console
dhcp-152-78-95-201:~ <localusername>$ sftp <sourceforgeusername>,rodin-b-sharp@web.sourceforge.net
Connecting to web.sourceforge.net...
<sourceforgeusername>,rodin-b-sharp@web.sourceforge.net's password: <sourceforgepassword>
sftp> cd htdocs
sftp> cd test-updates
sftp> ls -a
.          ..         .htaccess
sftp> put content.jar 
Uploading content.jar to /home/project-web/rodin-b-sharp/htdocs/test-updates/content.jar
content.jar                                                                                                                                            100%   82KB  82.3KB/s   00:01    
Uploading artifacts.jar to /home/project-web/rodin-b-sharp/htdocs/test-updates/artifacts.jar
artifacts.jar                                                                                                                                          100% 8975     8.8KB/s   00:00    

The .htaccess file redirects plugins/*.jar and features/*.jar requests to SourceForge FRS, thus using the archives that you have uploaded. Once the test is complete, please remove the jars:

sftp> rm *.jar
Removing /home/project-web/rodin-b-sharp/htdocs/test-updates/artifacts.jar
Removing /home/project-web/rodin-b-sharp/htdocs/test-updates/content.jar