Jump to: navigation, search

Mylyn/Release Howto

Before the Release

Prepare Build Environment

  • once Checkout releng on build.eclipse.org
ssh build.eclipse.org
git clone /gitroot/mylyn/org.eclipse.mylyn.git
  • Update releng on build.eclipse.org from Git
cd ~/org.eclipse.mylyn/
git pull
  • once Make sure your have Java 5.0 or later in your path. Settings for $HOME/.bashrc on build.eclipse.org:
export JAVA_HOME=/opt/public/common/jdk-1.6.x86_64
export ECLIPSE_HOME=~/.m2/repository/org/eclipse/tycho/tycho-p2-runtime/0.12.0/eclipse
  • once Run Maven on build.eclipse.org to download runtime
cd org.eclipse.mylyn
mvn package
  • once Create symlinks for convenience
ln -s /home/data/httpd/archive.eclipse.org/ ~/archive
ln -s org.eclipse.mylyn/org.eclipse.mylyn.releng ~/releng

Prepare Source Code

Internationalize Messages

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

Update User Guide from the Wiki

  • Run org.eclipse.mylyn.help.ui/build-helper.xml as an Ant Build (ensure WikiText is checked out into your workspace)
  • Review the user guide and commit changes

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 (available from the update site http://download.eclipse.org/eclipse/updates/4.3), Project context menu > Fix Copyrights

Create a Branch (Major Release Only)

  • Branch integration repository
git clone ssh://git.eclipse.org/gitroot/mylyn/org.eclipse.mylyn.all src-3_6_x
cd src-3_6_x
git checkout -b e_3_7_m_3_6_x
git submodule init
git submodule update
  • Branch each sub-project
git submodule foreach git pull
git submodule foreach git checkout -b e_3_7_m_3_6_x master
  • Copy .gitmodules from previous branch and update the branches to the current branch
  • Push changed .gitmodules file to new e_3_7_m_3_6_x branch
  • Push submodule branches
git submodule foreach git push origin e_3_7_m_3_6_x:e_3_7_m_3_6_x
  • configure mylyn-3.6.x-release job on Hudson to build from e_3_7_m_3_6_x branch
    • set BRANCH parameter passed to downstream builds
  • configure mylyn-3.6.x job at http://ci.mylyn.org/ to build from e_3_7_m_3_6_x branch

Release Review & IP Log

See Release_Cycle#Release_Review for details.

Submit IP Log for Review at least 2 weeks before release

  • Check IP log
    • Check that all Orbit bundles are tracked in approved CQs
  • Check the downloads area. The following missing CQ's are expected due to limitations of the project downloads scanner:
axis-ant.jar (No CQ found)
axis.jar (No CQ found)
epub-ant.jar (No CQ found)
htmltext.jar (No CQ found)
jaxrpc.jar (No CQ found)
junit.jar (No CQ found)

Seek PMC Approval for Release at least 2 weeks before release

Schedule Release Review at least 1 week before release

  • Once PMC and IP log approval are secured, send links to review document and mailing list discussion showing PMC approval to emo@eclipse.org

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. In practice, this step has to wait until after RC4.
    • Update versions of Eclipse Platform dependencies:
cd ~/releng/bin
./extractVersionsFromUpdateSite.sh ../../org.eclipse.mylyn-target/mylyn-e4.4.target ~/downloads/releases/luna/201409261001/ junit

Copy the desired suggestions to the target file.

    • To get version for org.eclipse.sdk.ide (a product IU)
unzip ~/downloads/releases/luna/201409261001/content.jar; grep "id='org.eclipse.sdk.ide'" content.xml; rm content.xml
./extractVersionsFromUpdateSite.sh ../../org.eclipse.mylyn-target/mylyn-e4.4.target ~/downloads/tools/orbit/downloads/drops/R20150519210750/repository/


  • If building from a branch, make sure the o.e.m.all repository is up to date. It usually updates automatically when changes are cherry-picked to submodule branches through Gerrit but may not when submodule branches are fast-forwarded.
  • Release builds (Hudson)
    • Select release as the type
    • Check publish
    • Once the build is complete, check the test results from the downstream jobs
  • Send a message to mylyn-dev with the location of the build inviting people to test it
  • 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

Update Discovery Jar

  • Update siteUrls and statsUrls in org.eclipse.mylyn/org.eclipse.mylyn.discovery-directory/plugin.xml to have the correct version
  • Check that the listings (supported versions) are up to date.

Run org.eclipse.mylyn.discovery-directory/build-helper.xml to produce a new jar. Then copy org.eclipse.mylyn.discovery.jar to ~/downloads/mylyn/discovery/, renaming it with the Mylyn version.

 scp org.eclipse.mylyn.discovery.jar

Make a second copy of the jar named with the next Mylyn version so that updating the framework version after the release (below) will not cause tests to fail.

 scp org.eclipse.mylyn.discovery.jar

Commit the changes.

Test Install

Update SimRel Contributions (Simultaneous Release Only)

  • provide help bundles from final build for info center as on bug 408828

Tag Sources

  • Tag the release as R_x_y_z (and R_x_y_z_e_3_3 if plug-ins are branched)
git submodule foreach git tag R_3_6_3
git tag R_3_6_3
  • Tag sub-projects with their respective versions as vx.y.z (e.g. v0.8.1):
  • Push tags
git submodule foreach git push --tags
git push --tags

Prepare Download Area

  • Log into Eclipse.org
ssh build.eclipse.org
  • Remove Old Integration Builds
rm -rf ~/downloads/mylyn/drops/3.6.0/I*
  • Also remove all RC builds (builds starting with a 'v') other than the latest
  • Update snapshot sites:
cd ~/downloads/mylyn/snapshots/
~/releng/bin/create-composite.sh -r
  • Copy Release to archive.eclipse.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/
  • Check that the content.jar contains the p2.mirrorsURL property:
~/releng/bin/check-metadata.sh v20140609-1648

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

Create API Baseline

  • major releases Create an API baseline zip
 cd ~/downloads/mylyn/drops/3.6.0
 ~/releng/bin/create-api-profile.sh 3.6.0 v20110608-1400

Update Release Repository Content

Note: If the release is part of the Simultaneous Release, this is the step that should wait until the official release day. That way the artifacts can be published early so they have time to mirror, but they won't be visible until this step is done.

  • Log into Eclipse.org
ssh build.eclipse.org
  • major releases Update filters in ~/downloads/mylyn/releases/*/composite.index
    • Ensure that ~/downloads/mylyn/releases/3.6 exists, where 3.6 is the version to be released, and that it contains a composite.index with appropriate content
cd ~/downloads/mylyn/releases/
cp -r 3.5 3.6
emacs 3.6/composite.index
  • Update release composite sites
cd ~/downloads/mylyn/releases/
~/releng/bin/create-composite.sh -r
rm -rf latest; cp -r 3.6 latest

Update Website

  • Update the version number on download page
  • Create a new section on download archive page
  • major releases Add a link to the new API baseline on the download archive page and update your development environment with the new baseline
  • Create a new section in the New & Noteworthy
  • Update the News section at http://eclipse.org/mylyn/
  • Update http://eclipse.org/mylyn/updates.xml
  • Create a discovery/directory-XX.xml for the next Mylyn version in the website Git, commenting out any 3rd party jars that haven't been created yet.

Update Babel

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

Announce Release

Update Marketplace Listings

After the Release

Update Versions

cd org.eclipse.mylyn.all
git checkout master
git pull
git submodule foreach git reset --hard
git submodule foreach git checkout master
git submodule foreach git pull
  • major release Update CoreUtil.FRAMEWORK_VERSION
  • major release Edit URL in org.eclipse.mylyn-feature/feature.xml
  • Edit versions in org.eclipse.mylyn/org.eclipse.mylyn.releng/bin/update-versions.sh
  • Push reviews in dependency order. After each set of reviews is merged, wait for the corresponding nightly builds to publish new snapshots before pushing the next set of reviews (for SRs, need to run the release build (e.g. 3.14.x) to publish snapshots). Push sets of reviews in this order:
  1. org.eclipse.mylyn, org.eclipse.mylyn.all (wait for or trigger mylyn-snapshot-publish before continuing)
  2. docs, commons
  3. tasks, versions
  4. context, reviews
  5. builds, incubator
  • If an upcoming simultaneous release will include the new Mylyn version, use b3 Aggregator editor to push version update to appropriate branch(es) of simrel.build repo. If only changing versions, can use find and replace in text editor instead of b3 editor. Make sure there is a snapshot build before pushing the version update.

Create Download Area

  • Create download directory (omit last argument if this is not a major release)
~/releng/bin/create-download-directory.sh 3.6.0 3.7.0 true
  • June release Create composite site for next Eclipse release
cp -r ~/downloads/mylyn/luna ~/downloads/mylyn/mars
  • major release Update composite site indices
emacs ~/downloads/mylyn/snapshots/*/composite.index
emacs ~/downloads/mylyn/incubator/3.7/composite.index
emacs ~/downloads/mylyn/incubator/latest/composite.index
  • Update snapshot sites
cd ~/downloads/mylyn/snapshots/
~/releng/bin/create-composite.sh -r
cd ~/downloads/mylyn/incubator
~/releng/bin/create-composite.sh -r

Create Build Job

  • Request mylyn-3.7.x-release job on Hudson cloning the previous release job
  • Configure job to build from master branch, trigger downstream jobs on master branch, and run weekly
  • Create a mylyn-3.7.x job at http://ci.mylyn.org/

Add Bugzilla Versions and Milestones

Update Project Plan


  • create-composite.sh: need to run this every time after deleting drops to make sure there are no stale references
  • Most of the examples assume you are releasing Mylyn 3.6 and then preparing for the 3.7 release
  • In this document, major release generally means anything other than a service release