Difference between revisions of "Platform UI/Build Submission"

Revision as of 00:41, 9 March 2009

Last update: January 27/2009

How to do an Integration Build submission

The following describes how to do an integration build submission. The steps for doing a maintenance submission are mostly the same except for how you set up the workspace in the first place. Perhaps someone could detail that.

Prep

1. It is best to keep an install/workspace around solely for the purpose of build submission. Take the latest milestone.
2. Install releng tools into your eclipse install
   1. p2 Steps
      1. *** This is no longer appears to be correct, need update info ***
      2. Go to Help->Update
      3. Add the following site http://download.eclipse.org/eclipse/testUpdates
      4. The releng tools show up when you enter "releng" in the filter field
      5. Install
   2. Old Steps
      1. Go to http://download.eclipse.org/eclipse/downloads/
      2. Pick the build matching your install
      3. Scroll to bottom, last section should be titled org.eclipse.releng.tools plug-in
      4. Download to your "dropins" dir under your install dir.
3. Note: to verify its installed, start up eclipse, pick a project and popup menu. You should see "Fix Copyrights..."

Steps

1. Load contents from CVS
   1. Check Out three things:the two modules (they will be at the bottom)
      1. Module platform-ui : Note: the projects org.eclipse.ui.carbon and org.eclipse.ui.cocoa will have errors if you are not on Carbon/Cocoa. At time of writing, org.eclipse.carbon generates 53 errors and org.eclipse.cocoa generates 41. You should have no other errors though. As well, org.eclipse.ui.win32 will have errors if you are not on Windows.
      2. Module platform-ui-tests
      3. Project org.eclipse.releng
2. Run the test suites. To do this:
   1. "Close Project" org.eclipse.ui.carbon and org.eclipse.ui.cocoa if you are not on Carbon/Cocoa. If you are not on Windows, close org.eclipse.ui.win32. Verify you now have no compile errors.
   2. Open up Run->Run Configurations
   3. Under JUnit Plug-in Test, select each test in turn and run. You can't multi select, so each test is run on its own.
   4. Note: The UI Tests, JFace-All and RCP Test Suite require that the workbench have focus otherwise you will get false errors. Go get a coffee while running these since you can't use your machine.
3. "Open Project" org.eclipse.ui.carbon and org.eclipse.ui.cocoa (and org.eclipse.ui.win32) if you closed them above.
4. The act of running the tests will modify some of the test suite projects. Reload (Update and Override) them to clear the local changes.
5. Select all the projects, pop up the menu and pick Team->Release...
6. If the banner shows an error "Invalid map project selected" then select the project org.eclipse.releng. It has the maps in it.
7. Leave selected "Use the default map project (org.eclipse.releng)". Click Next>.
8. There will be a tree with three top level items all checked. Deselect the first two, leaving "ui.map" and its children selected. Click Next>.
9. The next step takes some time while cvs info is checked.
10. The next page will be "Changed Projects". Check the "Generate Build Notes" option at the bottom. Click Next>
11. The system will be busy for a minute or two.
12. You will see the "Notes for Build Changes" page. Select all the text and paste into your mailer. Later, use this text to send an email (see below).
13. Check the "Update the Build Notes File" checkbox at the top, and fill in the build notes file field as "/org.eclipse.ui/buildnotes_workbench.html". Click Next>.
14. Type in the build tag, which is I or M (for integration or maintenance) followed by the build date-time (not the current date/time, the one at which the build will be run). So for example, I20071127-0800. Copy the text you typed in as you'll need it next. Leave the other options as is. Click Next>.
15. Enter the commit comment for the changed configuration file. Type "Submission for X-Y" where X-Y is the build date-time you entered for the tagging and copied.
16. If you get errors about projects already being tagged with the build tag, go back and modify the build tag to make it different

(i.e. place an "a" after it)

1. Send an email to platform-ui-dev@eclipse.org with the text from above notifying of the build submission.
2. For maintenance builds (towards the end), milestone week, or RC builds, send the same email to platform-releng-dev@eclipse.org so that everyone knows who contributed in the end game.