Reviews/R4E/Release Howto

Draft Content
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.

Reviews/R4E

Before the Release

Prepare Build Environment

TBD for Major releases

Create a Branch

TBD for major releases

Prepare Source Code

Internationalize Messages

• Run Source > Find Broken Externalized Strings over all bundles
• Run Source > Externalize Strings over all bundles

Update User Guide

• Adjust org.eclipse.mylyn.reviews.r4e.help/build-r4e-help.xml to set proxies as well as the plugin directory of the eclipse installation to use to find the Mylyn wikitext plug-ins
• Run org.eclipse.mylyn.reviews.r4e.help/build-r4e-help.xml as an Ant Build
• Review the user guide changes and then commit

Update Copyright Notices

• Update the year in the about.ini to the current year
• Update the year in all feature.xml files to the current year for changed features
• Update the year in copyright notices of changed source files: Install platform releng tools, Project context menu > Fix Copyrights
• You can alternatively use the following script to find files without copyrights

#!/bin/ksh
typeset -i mCnt
for mFile in `find . -name "*.java"`
do
  mCnt=`egrep -c 'Copyright' $mFile`
  if [ $mCnt -eq 0 ]; then
       echo "found"
       echo "File = "$mFile" does not contain 'copyright'"
  fi
done

Backport changes to the Platform Specific Branches

• Merge changes from master in each branched module

git merge master

Update Integration Repository

• Update integration repository to point to latest sub-project revisions

cd src-3_6_x
./update.sh

Run Tests

• Trigger a nightly build or run the AllTests suite

The Release

Update Target

• Update target files in org.eclipse.mylyn/org.eclipse.mylyn-target to point to release sites of dependencies to ensure builds are reproducible in the future

Tag Sources

• Tag the release as R_x_y_z (and R_x_y_z_e_3_3 if plug-ins are branched)

./foreach.sh git tag R_3_6_3

• Tag sub-projects with their respective versions as vx.y.z (e.g. v0.8.1):

org.eclipse.mylyn.builds
org.eclipse.mylyn.docs
org.eclipse.mylyn.reviews
org.eclipse.mylyn.versions

• Push tags

git submodule foreach git push --tags

Build

• Release build (Hudson): https://hudson.eclipse.org/hudson/job/mylyn-release/
  • Select release as the type
  • Check publish
  • Enter timestamp for qualifier
• Release build (manually):

mvn -Prelease -DforceContextQualifier=v20110304-0100 -Ppublish -Phudson.eclipse.org -Pindigo -Dexplicit-target -Dmaven.test.skip=true -Dtycho-version=0.12.0 -Dsign-dir=tools/mylyn/hudson/release clean install

• Snapshot build (manually):

mvn -Psnapshot -Ppublish -Phudson.eclipse.org -Pindigo -Dexplicit-target -Dmaven.test.skip=true -Dtycho-version=0.12.0 -Dsign-dir=tools/mylyn/hudson/snapshot clean install

Verify Update Site Contents

• Check that only approved features are on the update site
• Check that all Orbit bundles are tracked in approved CQs

Test Install

• Do a test install from http://download.eclipse.org/mylyn/snapshots/weekly

Prepare Download Area

• Log into Eclipse.org

ssh build.eclipse.org

• Remove Old Integration Builds

rm -rf ~/downloads/mylyn/drops/3.6.0/I*

• Copy Release to archive.eclipes.org

cp -a ~/downloads/mylyn/drops/3.6.0 /home/data/httpd/archive.eclipse.org/mylyn/drops

• Run script to add mirror URLs

cd ~/downloads/mylyn/drops/3.6.0/
~/releng/bin/update-metadata.sh

• Check that the content.jar contains the following property:

<property name="p2.mirrorsURL" value="http://www.eclipse.org/downloads/download.php?file=/mylyn/drops/.../v.../&protocol=http&format=xml"/>

Update Release Repository Content

• Log into Eclipse.org

ssh dev.eclipse.org

• Update filters in ~/downloads/mylyn/releases/*/composite.index
• Update release composite sites

cd ~/downloads/mylyn/releases/
~/releng/bin/create-composite.sh -r

Create API Baseline

• major releases Create an API baseline zip

 ~/releng/bin/create-api-profile.sh 3.6.0 v20110608-1400

Update Website

• Update the version number on download page
• Create a new section on download archive page
• Create a new section in the New & Noteworthy
• major releases Add a link to the new API baseline on the download archive page and update the developer page
• major releases Archive project plan in mylyn/docs

Update Babel

• Make release available in Eclipse Babel for translation (major releases only)

Announce Release

• Send announcement to mylyn-announce
• Post announcement to news group

Update http://eclipse.org/mylyn/updates.xml

• Edit /mylyn/notification.xml in website CVS

Update Eclipse Info Center

• Inform webmaster of new help plug-ins for the Eclipse info center

Update Marketplace Listings

• major releases Mylyn
• major releases Trac Connector

After the Release

Update Versions

• Edit versions in org.eclipse.mylyn/org.eclipse.mylyn.releng/bin/update-versions.sh

org.eclipse.mylyn/org.eclipse.mylyn.releng/bin/update-versions.sh

• Set versions of org.eclipse.mylyn.commons/org.eclipse.mylyn to the next release version
• Update version in CoreUtil.FRAMEWORK_VERSION
• Update URL in ConnectorDiscoveryWizardMainPage.DEFAULT_DIRECTORY_URL

Update Repository URL

• major release Edit URL in org.eclipse.mylyn-feature/feature.xml

Create Download Area

• Create download directory

mkdir ~/downloads/mylyn/drops/3.7.0/
setfacl -m user:hudsonBuild:rwx ~/downloads/mylyn/drops/3.7.0/
setfacl -R -x user:hudsonBuild ~/downloads/mylyn/drops/3.6.0/

• major release Create snapshot site

cp -a ~/downloads/mylyn/snapshots/3.6 ~/downloads/mylyn/snapshots/3.7

• major release Update composite site indices

emacs ~/downloads/mylyn/snapshots/*/composite.index

• Update snapshot sites

cd ~/downloads/mylyn/snapshots/
~/releng/bin/create-composite.sh -r

• major release Create Incubator download directory

mkdir ~/downloads/mylyn/incubator/drops/3.7.0
setfacl -m user:hudsonBuild:rwx ~/downloads/mylyn/incubator/drops/3.7.0/
setfacl -R -x user:hudsonBuild ~/downloads/mylyn/incubator/drops/3.6.0/

• major release Create Incubator site

cp -a ~/downloads/mylyn/incubator/3.6 cp -a ~/downloads/mylyn/incubator/3.7
emacs ~/downloads/mylyn/incubator/3.7/composite.index

• Update composite site

cd ~/downloads/mylyn/incubator
~/releng/bin/create-composite.sh -r

Add Bugzilla Versions and Milestones

• Add Bugzilla Milestones for the next release
• major release Add Bugzilla Version for the current release

Update Project Plan

• major release Update versions and queries in all plan.xml documents
• major release Update release plans in portal