Debug/DebugRelEng

From Eclipsepedia

Jump to: navigation, search
Platform Debug
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source
JDT Debug
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source

Contents

Introduction

Being part of the Eclipse platform requires that for each I-build in the Eclipse build schedule all of the debug plugins must be released to the build.

This process only has a few requirements:

  1. you have all of the required bundles
  2. you have commit rights to all of the required bundles
  3. you have no pending changes in your RelEng workspace
  4. you have EGit and/or Git on the command line

Bundles Needed To Release

Now that Platform / JDT debug in is Git, it is much easier to get the required bundles. You simply have to check out the following two repos:

  1. JDT Debug
  2. Platform Debug

There is an additional required bundle that contains all of the map files that must be updated, which is: org.eclipse.releng and can be found in the RelEng maps Git repo.


Releasing Bundles

With the RelEng tools installed and working, and all of the required projects selected you must start the Release wizard by doing one of the following:

  1. right-clicking on the selected projects and using the Team > Release... command
  2. click the Release Projects toolbar button in the main toolbar. This option is not available by default, so to use it you first must go to Window > Customize Perspective and enable the command group for RelEng Tools

Map Files

If you have used the wizard before and told it to not ask for a map project anymore, you will not see the following page of the wizard. If this is your first time, the first page of the Release wizard asks you to select the map file project.

For the debug projects this will always be org.eclipse.releng. If at some point you have told the wizard to always use a given project, and would like to choose another - i.e. once again show you the first page of the wizard above - you can enable the option to always ask for map projects on the Team > Releng Map Project Selection preference page within Eclipse.

With the map file project selected, the next step allows you to select all of the projects you want to release. You can see in the following screen shot that all of the projects we selected in the workspace are initially selected and they presented grouped under the map file they belong to.

It is expected that all of the debug projects appear under the jdtdebug map and that org.eclipse.core.variables appears under the core-variables map.

There is a very important preference on this page, it is the Release only projects that have changed since the last release preference. When this option is checked the wizard will consult CVS to find what change have been made to the projects since the last time the bundles were released. If the wizard finds no changes the bundles will not be released. If you want to tag all of the bundles regardless of changes since the last release, you must un-check this option. Doing so will also cause the wizard to skip past the Project Changes and the Notes for Build Changes pages mentioned below.

The last step in choosing what and where to release is to view the changes that have been found since the last time the bundles were released. If, however, you un-checked the only released changed projects... option from above you will not see this page.

This page also contains an important, but often overlooked option - the Generate Build Notes option. This option will consult CVS and collect all of the commit comments for any of the project changes it shows you on this page. The advantage of using this is so you can easily send the status email once the bundles are released. More on this in the next section.

Build Notes

First thing to note is, if you un-checked the only released changed projects... option mentioned above, you will not be presented with this page. If you left that option checked and also left the Generate Build Notes option mentioned above checked, you will see the Notes For Build Changes page.

This page allows you to automatically update a build notes file - which we do not use in debug - and presents you with a nicely formatted text blurb of all of the commit comments for the changes that will be released. At this point you will want to copy that text as it is used in the status email that must be sent to the debug mailing lists (platform-debug-dev@eclipse.org and jdt-debug-dev@eclipse.org )after the release is complete. The reason for this is so that the other debug committers (and any other interested parties) know what fixes / enhancements will be available in the next I-build. Also it lets the other committers know that the bundles have been released.

Choosing Tags

Other than making sure you are releasing all of the correct changes, selecting the right tag is probably the most important step in the process. Typically, using the drop-down and selecting the first selection will be fine, but there are exceptions.

Exceptions:

  1. if you have to release the same bundle more than once on the same day you must add a postfix to the tag and never select the option to move the tag if it exists. For example say you released the bundles under the tag v20110511 at noon, but then later in the day a new fix was added and you had to re-tag. In this case the default choice would again be v20110511, but you already used it. In this case the de-facto standard debug uses is to append a letter to the tag as needed: v20110511a, v20110511b, etc, etc for as many times as you release the bundles in the same day.
  2. if you need to tag the bundles for a particular release for a non-HEAD branch. In this case it is the de-facto standard for debug to add a postfix about the branch to the tag name. For example if you had to release the bundles in the R3_6_maintenance branch you would use something like: v20110511_r362.


The absolutely most important part of choosing tags is to never EVER select the option to move a tag if it already exists. This can cause all kinds of problems in the Eclipse build process. It is also a good idea to make sure the option Validate the release once completed is checked.


After you have selected the tag you want to use, the next page allows you to view the changes that will be made to the map files.

Committing the Release

This one is easy. You have to enter a commit comment and press the finish button to perform the release.