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 "Modeling Project Releng/Building/Signing And Packing"

(Testing / Install Verification)
(add UML2 example)
Line 15: Line 15:
 
== Process ==
 
== Process ==
  
1. Create an "all" or "master" feature, which will build SDK, examples, and any other features you might build. This obsoletes the need for an SDK builder, runtime builder, doc builder, and examples builder. You can still use your custom doc plugin builder; this just cleans up some redundancies in your .releng project.
+
1. Create an "all" or "master" feature, which will build SDK, examples, and any other features you might build. This obsoletes the need for an SDK builder, runtime builder, doc builder, and examples builder. You can still use your custom doc plugin builder; this just cleans up some redundancies in your .releng project.
 +
 
 +
If your SDK feature already contains all your smaller features (including runtime, source, doc, and examples, but not tests) then you don't need a new "all" feature.
  
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet/plugins/org.eclipse.jet.all-feature?root=Modeling_Project JET All-In-One ("Master") Feature]
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet/plugins/org.eclipse.jet.all-feature?root=Modeling_Project JET All-In-One ("Master") Feature]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/features/org.eclipse.gef.all-feature?root=Tools_Project GEF All-In-One ("Master") Feature]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/features/org.eclipse.gef.all-feature?root=Tools_Project GEF All-In-One ("Master") Feature]
 +
* Example 3: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.mdt/org.eclipse.uml2/plugins/org.eclipse.uml2.sdk-feature?root=Modeling_Project UML2 SDK Feature] (already includes Examples)
  
 
2. Add this new feature to your map file.
 
2. Add this new feature to your map file.
Line 24: Line 27:
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/maps/jet.map?root=Modeling_Project JET map]
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/maps/jet.map?root=Modeling_Project JET map]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/maps/gef.map?root=Tools_Project GEF map]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/maps/gef.map?root=Tools_Project GEF map]
 +
* Example 3: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.mdt/org.eclipse.uml2.releng/maps/uml2.map?root=Modeling_Project UML2 map] (no change)
  
3. Add a new builder/all/ folder in your .releng project. Your old builder/sdk, builder/doc, builder/examples folders are no longer required and can be deleted.
+
3. Add a new builder/all/ folder in your .releng project. Your old builder/sdk, builder/doc, builder/examples folders are no longer required and can be deleted. As in step 1, if you're reusing your SDK feature, this step is not required. Just update your customTargets.xml to create the Master Zip.
  
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/builder/all/?root=Modeling_Project JET's /builder/all/]
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/builder/all/?root=Modeling_Project JET's /builder/all/]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/builder/all/?root=Tools_Project GEF's /builder/all/]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/builder/all/?root=Tools_Project GEF's /builder/all/]
 +
* Example 3: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.mdt/org.eclipse.uml2.releng/builder/sdk/customTargets.xml?root=Modeling_Project&r1=1.5&r2=1.6 UML2's /builder/sdk/customTargets.xml]
  
 
4. Change your .releng/buildAll.xml to use new [http://dev.eclipse.org/viewcvs/index.cgi/releng-common/tools/scripts/buildAllHelper.xml?root=Modeling_Project&view=markup signing/packing code]. You'll notice that many targets have been removed to buildAllHelper.xml to simplify this file, and some things have been reordered. The most important change is that you must now define your own packaging; however, by only doing a single PDE build for the whole "All" feature (and a second one for your tests), your build will run faster. This is important because jar signing can take a few minutes or as much as an hour, depending on the queue ahead of your build.
 
4. Change your .releng/buildAll.xml to use new [http://dev.eclipse.org/viewcvs/index.cgi/releng-common/tools/scripts/buildAllHelper.xml?root=Modeling_Project&view=markup signing/packing code]. You'll notice that many targets have been removed to buildAllHelper.xml to simplify this file, and some things have been reordered. The most important change is that you must now define your own packaging; however, by only doing a single PDE build for the whole "All" feature (and a second one for your tests), your build will run faster. This is important because jar signing can take a few minutes or as much as an hour, depending on the queue ahead of your build.
Line 34: Line 39:
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/buildAll.xml?root=Modeling_Project&view=markup JET's buildAll.xml] [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/buildAll.xml?root=Modeling_Project&r1=1.12&r2=1.25 changes]
 
* Example 1: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/buildAll.xml?root=Modeling_Project&view=markup JET's buildAll.xml] [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/buildAll.xml?root=Modeling_Project&r1=1.12&r2=1.25 changes]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/buildAll.xml?root=Tools_Project&view=markup GEF's buildAll.xml] [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/buildAll.xml?root=Tools_Project&r1=1.8&r2=1.43 changes]
 
* Example 2: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/buildAll.xml?root=Tools_Project&view=markup GEF's buildAll.xml] [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/buildAll.xml?root=Tools_Project&r1=1.8&r2=1.43 changes]
 +
* Example 3: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.mdt/org.eclipse.uml2.releng/buildAll.xml?root=Modeling_Project&view=markup UML2's buildAll.xml]
  
 
5. Use the Master zip as input to the [http://dev.eclipse.org/viewcvs/index.cgi/releng-common/tools/scripts/buildUpdate.sh?root=Modeling_Project&view=markup buildUpdate.sh] script, by updating your [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/promoteToEclipse.jet.properties?root=Modeling_Project&view=markup promoteToEclipse.*.properties] [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/promoteToEclipse.gef.properties?root=Tools_Project&view=markup file].
 
5. Use the Master zip as input to the [http://dev.eclipse.org/viewcvs/index.cgi/releng-common/tools/scripts/buildUpdate.sh?root=Modeling_Project&view=markup buildUpdate.sh] script, by updating your [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2t/org.eclipse.jet.releng/promoteToEclipse.jet.properties?root=Modeling_Project&view=markup promoteToEclipse.*.properties] [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.gef/org.eclipse.gef.releng/promoteToEclipse.gef.properties?root=Tools_Project&view=markup file].

Revision as of 17:56, 11 February 2008

This document is a work in progress.

Requirements

1. You must have permission to ssh to build.eclipse.org. This is where the signing will occur.

2. You must be able to ssh from your build server to build.eclipse.org without being prompted for a host key or password. The first time you try to connect from your build server, accept the host key and you should never be prompted again. If you can ssh from your build server to dev.eclipse.org or download1.eclipse.org, you should be able to connect to build.eclipse.org using the same credentials and ssh key.

3. While on build.eclipse.org, you must be able to create files in your staging folder, eg., /home/data/httpd/download-staging.priv/modeling/emft.

4. While on build.eclipse.org, you must be able to run /usr/bin/jarsigner.

If you cannot do any of the above things, open a bug and ask for access. cc: your PMC for approval and optionally, User:Nickb.

Process

1. Create an "all" or "master" feature, which will build SDK, examples, and any other features you might build. This obsoletes the need for an SDK builder, runtime builder, doc builder, and examples builder. You can still use your custom doc plugin builder; this just cleans up some redundancies in your .releng project.

If your SDK feature already contains all your smaller features (including runtime, source, doc, and examples, but not tests) then you don't need a new "all" feature.

2. Add this new feature to your map file.

3. Add a new builder/all/ folder in your .releng project. Your old builder/sdk, builder/doc, builder/examples folders are no longer required and can be deleted. As in step 1, if you're reusing your SDK feature, this step is not required. Just update your customTargets.xml to create the Master Zip.

4. Change your .releng/buildAll.xml to use new signing/packing code. You'll notice that many targets have been removed to buildAllHelper.xml to simplify this file, and some things have been reordered. The most important change is that you must now define your own packaging; however, by only doing a single PDE build for the whole "All" feature (and a second one for your tests), your build will run faster. This is important because jar signing can take a few minutes or as much as an hour, depending on the queue ahead of your build.

5. Use the Master zip as input to the buildUpdate.sh script, by updating your promoteToEclipse.*.properties file.

# zip(s) to use for update site generation
filePrefixesToUnzipArray=( "GEF-Master-" );

6. Add pack200="true" to all your update site's site*.xml files:

<site pack200="true" ...>

7. Promote as before.

Testing / Install Verification

When you install your signed features from the update site, you should see something like this:

Gef-3.4-signed-features.png

Bugs

  • bug 173651: Support Pack200 in Modeling builds / update sites
  • bug 217929: M2T Signing & Packing
  • bug 217945: Problems with file permissions in signed/packed jars
  • bug 211613: JDK 6's Pack200 is not backward compatible with JDK 5 if packed jars contain no classfiles

References

Copyright © Eclipse Foundation, Inc. All Rights Reserved.