DTPReleaseContributionInstructions

Prepare a DTP Milestone Release

The uploading of nightly builds is automatically done by the DTP build scripts, including files upload and downloads page updates.

Prepare the DTP Milestone Update Site

To promote a nightly/integration build as Milestone build, login to “build.eclipse.org” with shell access.
A build administrator user account has a $HOME/downloads link, which should already be setup as a symbolic link to the downloads site.

1. Copy the update site contents from the appropriate Nightly build directory to the Milestone build directory on "build.eclipse.org". For example,

DTP 1.12.0 Milestone update site directory:

~/downloads/datatools/downloads/drops/M_updates_1.12.0

DTP 1.12.0 Nightly update site directory:

~/downloads/datatools/downloads/drops/N_updates_1.12.0/v<buildTimestamp>

1.1 Create a new directory for staging milestone update site. For example,

     cd ~/downloads/datatools/downloads/drops
     mkdir M_updates_1.12.0_staging

1.2 Copy the features and plugins folders from a Nightly build directory to the staging milestone directory. For example,

     cd ~/downloads/datatools/downloads/drops/N_updates_1.12.0/v<buildTimestamp>
     cp -pr features plugins ../../M_updates_1.12.0_staging
     cd ~/downloads/datatools/downloads/drops/M_updates_1.12.0_staging
     chmod g+w features plugins

1.3 Copy the file “site.xml” from the last milestone directory to the staging directory. For example,

     cd ~/downloads/datatools/downloads/drops/M_updates_1.12.0_staging 
     cp ../M_updates_1.12.0/site.xml .

1.4 Edit the site.xml file in the staging milestone directory

Update the value of the feature url and version attributes to the version of the 2 top-level feature jars found in the features directory (that were copied in a previous step). For example,

  <feature url="features/org.eclipse.datatools.sdk.feature_1.12.0.v201402260523-7PB13FEpPZQWdrtqnY7SM0Geyqpc.jar" 
    id="org.eclipse.datatools.sdk.feature" 
    version="1.12.0.v201402260523-7PB13FEpPZQWdrtqnY7SM0Geyqpc">

  <feature url="features/org.eclipse.datatools.enablement.sdk.feature_1.12.0.v201402250837-7IAB-FE9JgeWia2S7rHTvaz0iuBF.jar" 
    id="org.eclipse.datatools.enablement.sdk.feature" 
    version="1.12.0.v201402250837-7IAB-FE9JgeWia2S7rHTvaz0iuBF">

1.5 Generate the P2 metadata files (artifacts.jar and content.jar) in the staging milestone directory

(See the script and related directories packaged in ~/downloads/datatools/tools/dtp-tools.tar.

Extract from dtp-tools.tar to your own account working area, as needed. Then “unzip jdk15.zip” for the JVM to use in below command.)

Run below script command, having substituted the appropriate target update site directory name, e.g. substitute "M_updates_<version>_staging" with “M_updates_1.11.2_staging”.

The generated artifacts.jar and content.jar files will be written to the directory specified by the –targetDir argument.

 ./buildUpdateSiteMetadata.sh -p DTP -basebuilderDir ${HOME}/dtp-tools/org.eclipse.releng.basebuilder 
    -targetDir ${HOME}/downloads/datatools/downloads/drops/M_updates_<version>_staging  
    -vm ${HOME}/dtp-tools/jdk1.5.0_09/bin/java &

When ready to promote the milestone build,

1.6 Rename the last milestone directory for backup. For example,

     mv  M_updates_1.12.0  M_updates_1.12.0_rc1

1.7 Rename the staging milestone directory to the milestone directory, as specified in site.xml. For example,

     mv M_updates_1.12.0_staging M_updates_1.12.0

Contribute a DTP Milestone to Eclipse Simultaneous Release

See Contributing_to_Simrel_Aggregation_Build for how to install the “b3 Aggregator Editor”, and how to clone the simrel Git repository.
As of 2/2014, the master branch is for Luna release, and the Kepler_maintenance branch is for the Kepler SR2 release. Pushing the same content in the dtp.b3aggrcon file to both branches would mean promoting the same DTP build to both Luna and Kepler SR2 release.

Git repo URI: ssh://<eclipseid>@git.eclipse.org/gitroot/simrel/org.eclipse.simrel.build.git

2.1. Edit the dtp.b3aggrcon file.

• Update the versionRange attribute value of the 2 feature elements. The "*.feature.group" suffix in name attribute are used by the simrel build scripts.

The versionRange value must match those specified in site.xml file for the 2 top-level feature jars (listed below), as found in the drops’ features directory:

• org.eclipse.datatools.sdk.feature
• org.eclipse.datatools.enablement.sdk.feature

• Save the dtp.b3aggrcon file.
• Now use the b3 Aggregator Model Editor to open the top level simrel.b3aggr file. Then run the contextMenu->Validate command on "Contribution: DataTools", and make sure the validation completes successfully, with no errors flagged with red X's.
• Commit and push the dtp.b3aggrcon file changes to master branch (for Luna), and/or Kepler_maintenance branch (for Kepler SR2)

2.2. Add your email as contact, and remove obsolete ones, as appropriate. You will get emails if simrel build failure is caused by DTP contribution.

• Use the b3 Aggregator Model Editor to open and edit the top level simrel.b3aggr file, which will also automatically update the dtp.b3aggrcon file, as appropriate.
• Add Contacts; show Property View to specify both Email and Name.
• Save the simrel.b3aggr file. Now run the contextMenu->Validate command.

This would make the changes in two places: 1) dtp.b3aggrcon file, and 2) simrel.b3aggr file. They contain "model element" that "points both ways". The b3 aggregator would 'validate' that its model is correct.

• Commit and push both changed files to the simrel Git repo.

Update a Milestone build on the DTP Downloads page

• Update the DTP downloads page with the downloadable zip files path in the Milestone and/or Integration Builds sections.

The downloads.php file is in the DTP Project Git repository:

     ssh://<user>@git.eclipse.org/gitroot/www.eclipse.org/datatools.git

• Commit and push the modified downloads.php file to the DTP project Git repository.

Prepare a DTP GA Release

DTP contributes to the Eclipse Simultaneous Release, which has specific schedule for all contributing projects to make each of their GA releases visible to the public.
See Simultaneous Release FAQ for related guidelines.

To promote a Release Candidate build to be the GA build, login to “build.eclipse.org” with shell access to manually update the GA Release update site directory.

Prepare the DTP GA Update Site

Copy the update site contents from the RC Milestone directory to the GA directory on "build.eclipse.org". For example,

DTP 1.12.0 Milestone update site directory:

~/downloads/datatools/downloads/drops/M_updates_1.12.0

DTP 1.12 GA update site directory for all 1.12.x releases:

~/downloads/datatools/updates/1.12

1.1 Copy the features and plugins folders from the RC Milestone directory to the GA directory. For example,

     cd ~/downloads/datatools/downloads/drops/M_updates_1.12.0
     cp -pur features/* ~/downloads/datatools/updates/1.12/features
     cp -pur plugins/* ~/downloads/datatools/updates/1.12/plugins

1.2 Archive the metadata of the previous SR<n> release, if applicable

     cd ~/downloads/datatools/updates/1.12
     cp -p site.xml *.jar ~/downloads/datatools/archives/dtpUpdates/1.12
     rm *.jar

1.3 Edit the site.xml file in the GA directory

Copy the the DTP <feature> elements and <category-def> elements in site.xml file from the RC Milestone directory,

and append to the site.xml file in the GA directory.

1.4 Generate the P2 metadata files (artifacts.jar and content.jar) for the GA directory

Run below script command, having substituted the target directory name to that of the GA directory.

The generated artifacts.jar and content.jar files will be written to the directory specified by the –targetDir argument.

 cd ~/dtp-tools
 ./buildUpdateSiteMetadata.sh -p DTP -basebuilderDir ${HOME}/dtp-tools/org.eclipse.releng.basebuilder 
    -targetDir ${HOME}/downloads/datatools/updates/<GA_version>  
    -vm ${HOME}/dtp-tools/jdk1.5.0_09/bin/java &

NOTE: There is no need to update the Eclipse Simultaneous Release file, such as dtp.b3aggrcon file, for the GA release.

Prepare the DTP GA Release Download Files

Copy the download zip files from the appropriate download directory to the GA download directory on "build.eclipse.org". For example,

DTP 1.12.0 daily download directory:

~/downloads/datatools/downloads/drops/N_DTP_1.12.0

DTP 1.12 GA download directory for all 1.12.x downloads:

~/downloads/datatools/downloads/1.12

2.1 Copy the last RC download zip files and map file from the daily download directory to the GA download directory. For example,

     cd ~/downloads/datatools/downloads/drops/N_DTP_1.12.0
     cp -p directory_I.txt dtp*RC4*.zip  ~/downloads/datatools/downloads/1.12

     cd ~/downloads/datatools/downloads/1.12
     mv directory_I.txt directory_1.12.0.txt
     mv dtp-1.12.0RC4-<timestamp>.zip  dtp_1.12.0.zip
     mv dtp-p2repo-1.12.0RC4-<timestamp>.zip  dtp-p2repo_1.12.0.zip
     mv dtp-sdk-1.12.0RC4-<timestamp>.zip  dtp-sdk_1.12.0.zip
     chmod 664  *_1.12.0.*

Update the DTP Downloads page for a GA Release

3.1 Update the DTP downloads page file (downloads.php) with the download-able zip files path in the Current Release section.

3.2 Commit and push the modified downloads.php file to the DTP project Git repository.

Update the Version of a DTP Build

For each new DTP release version, update the following source files to the new version number.

1. Update the feature.xml file of all DTP Feature projects (prefixed with org.eclipse.datatools.* in the org.eclipse.datatools.build Git repository).

For example, if updating the DTP build version to "1.12.0", change the:

• Feature version to 1.12.0.qualifier
• Feature version of all required DTP feature dependencies to 1.12.0
• Update Site URL and Discovery site URL to the DTP update site URL that is used for all 1.12.x releases: http://download.eclipse.org/datatools/updates/1.12

  <url>
     <update label="%updateSiteName" url="http://download.eclipse.org/datatools/updates/1.12"/>
     <discovery label="%updateSiteName" url="http://download.eclipse.org/datatools/updates/1.12"/>
  </url>

2. Update the plugin version of org.eclipse.datatools.doc.isv to 1.12.0.qualifier

The plugin source is kept in the org.eclipse.datatools.doc Git repository.