Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Mylyn/Release Howto"

(Create a Branch (Major Release Only))
(Create Build Jobs)
(20 intermediate revisions by 2 users not shown)
Line 36: Line 36:
  
 
== Create a Branch (Major Release Only) ==
 
== Create a Branch (Major Release Only) ==
* Branch integration repository
+
 
 +
* Branch integration repository. Note: replace clone command with "git pull" if repository is already cloned.
 
  git clone ssh://git.eclipse.org/gitroot/mylyn/org.eclipse.mylyn.all src-3_6_x
 
  git clone ssh://git.eclipse.org/gitroot/mylyn/org.eclipse.mylyn.all src-3_6_x
 
  cd src-3_6_x
 
  cd src-3_6_x
Line 43: Line 44:
 
  git submodule update
 
  git submodule update
 
* Branch each sub-project
 
* Branch each sub-project
 +
git submodule foreach git checkout master
 
  git submodule foreach git pull
 
  git submodule foreach git pull
 
  git submodule foreach git checkout -b e_3_7_m_3_6_x master
 
  git submodule foreach git checkout -b e_3_7_m_3_6_x master
Line 49: Line 51:
 
* Push submodule branches
 
* Push submodule branches
 
  git submodule foreach git push origin e_3_7_m_3_6_x:e_3_7_m_3_6_x
 
  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
+
* configure mylyn-3.6.x-release job on Hudson
 +
** set to build from e_3_7_m_3_6_x branch
 
** set BRANCH parameter passed to downstream builds
 
** set BRANCH parameter passed to downstream builds
 
** edit the build schedule so it won't build automatically after this point
 
** edit the build schedule so it won't build automatically after this point
Line 59: Line 62:
  
 
=== Submit IP Log for Review ''at least 2 weeks before release'' ===
 
=== Submit IP Log for Review ''at least 2 weeks before release'' ===
* Submit [http://www.eclipse.org/projects/ip_log.php?id=mylyn,mylyn.builds,mylyn.commons,mylyn.context,mylyn.docs,mylyn.reviews,mylyn.tasks,mylyn.versions IP log]
+
* Check the [http://eclipse.org/projects/tools/downloads.php?id=mylyn downloads area].
 
** Check that all Orbit bundles are tracked in approved CQs
 
** Check that all Orbit bundles are tracked in approved CQs
* Check the [http://eclipse.org/projects/tools/downloads.php?id=mylyn downloads area]. The following missing CQ's are expected due to limitations of the project downloads scanner:
+
** The following missing CQ's are expected due to limitations of the project downloads scanner:
 
  axis-ant.jar (No CQ found)
 
  axis-ant.jar (No CQ found)
 
  axis.jar (No CQ found)
 
  axis.jar (No CQ found)
Line 68: Line 71:
 
  jaxrpc.jar (No CQ found)
 
  jaxrpc.jar (No CQ found)
 
  junit.jar (No CQ found)
 
  junit.jar (No CQ found)
 +
* Submit [http://www.eclipse.org/projects/ip_log.php?id=mylyn,mylyn.builds,mylyn.commons,mylyn.context,mylyn.docs,mylyn.reviews,mylyn.tasks,mylyn.versions IP log]
  
 
=== Seek PMC Approval for Release ''at least 2 weeks before release'' ===
 
=== Seek PMC Approval for Release ''at least 2 weeks before release'' ===
Line 84: Line 88:
  
 
== Build ==
 
== Build ==
* If building from a branch, make sure the o.e.m.all repository is up to date. It doesn't always update automatically.
+
* If building from a branch, make sure that all needed changes are on the branch and that the o.e.m.all repository is up to date. It doesn't always update automatically.
* [https://hudson.eclipse.org/hudson/user/spingel/my-views/view/Mylyn%20Release/ Release builds (Hudson)]
+
* [https://hudson.eclipse.org/mylyn/view/Releases/ Release builds (Hudson)]
** Select release as the type
+
 
** Check publish
 
** Check publish
 
** Once the build is complete, check the test results from the downstream jobs
 
** 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):
 
* Release build (manually):
 
   
 
   
Line 167: Line 169:
 
  ssh build.eclipse.org
 
  ssh build.eclipse.org
 
*  ''major releases'' Update filters in <tt>~/downloads/mylyn/releases/*/composite.index</tt>
 
*  ''major releases'' Update filters in <tt>~/downloads/mylyn/releases/*/composite.index</tt>
** 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
+
** Ensure that composites for the release exist:
 
  cd ~/downloads/mylyn/releases/
 
  cd ~/downloads/mylyn/releases/
 
  cp -r 3.5 3.6
 
  cp -r 3.5 3.6
Line 175: Line 177:
 
  ~/releng/bin/create-composite.sh -r
 
  ~/releng/bin/create-composite.sh -r
 
  rm -rf latest; cp -r 3.6 latest
 
  rm -rf latest; cp -r 3.6 latest
 +
  
 
== Update Website ==
 
== Update Website ==
Line 181: Line 184:
 
* ''major releases'' Add a link to the new API baseline on the download archive page and update your development environment with the new baseline
 
* ''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 &amp; Noteworthy
 
* Create a new section in the New &amp; Noteworthy
* Update the News section at http://eclipse.org/mylyn/
+
* Update the Releases section at http://eclipse.org/mylyn/
 
* Update http://eclipse.org/mylyn/updates.xml
 
* 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.
 
* 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.
Line 216: Line 219:
 
# tasks, versions
 
# tasks, versions
 
# context, reviews
 
# context, reviews
# builds, incubator
+
# builds
  
* If an upcoming simultaneous release will include the new Mylyn version, use [[Eclipse_b3/aggregator/manual | b3 Aggregator editor]] to [[Simrel/Contributing_to_Simrel_Aggregation_Build|update]] versions and push a review to the appropriate branch(es) (e.g. Mars_maintenance and master) of [http://git.eclipse.org/c/simrel/org.eclipse.simrel.build.git/ simrel.build repo]. The build will not pass until a Mylyn snapshot is built. If only changing versions, can use find and replace in text editor instead of b3 editor.
+
* Update the default value of the BRANCH parameter of http://ci.mylyn.org/view/Snapshots/job/update-simrel-contribution/ with the branches that should get the next Mylyn version, or disable the job if no SimRel will include this version. This will normally be "master" (contribute to the next release of Eclipse), but can have a space-delmited list of other eclipse versions to contribute to.  As soon as the new Eclipse version is released in June, we need to include master and the new release branch (for example, "master Neon_maintenance").
  
 
== Create Download Area ==
 
== Create Download Area ==
Line 224: Line 227:
 
  ~/releng/bin/create-download-directory.sh 3.6.0 3.7.0 true
 
  ~/releng/bin/create-download-directory.sh 3.6.0 3.7.0 true
 
* ''June release'' Create composite site for next Eclipse release
 
* ''June release'' Create composite site for next Eclipse release
  cp -r ~/downloads/mylyn/luna ~/downloads/mylyn/mars
+
  cp -r ~/downloads/mylyn/releases/luna ~/downloads/mylyn/releases/mars
 
* ''major release'' Update composite site indices  
 
* ''major release'' Update composite site indices  
 
  emacs ~/downloads/mylyn/snapshots/*/composite.index
 
  emacs ~/downloads/mylyn/snapshots/*/composite.index
emacs ~/downloads/mylyn/incubator/3.7/composite.index
 
emacs ~/downloads/mylyn/incubator/latest/composite.index
 
 
* Update snapshot sites
 
* Update snapshot sites
 
  cd ~/downloads/mylyn/snapshots/
 
  cd ~/downloads/mylyn/snapshots/
~/releng/bin/create-composite.sh -r
 
cd ~/downloads/mylyn/incubator
 
 
  ~/releng/bin/create-composite.sh -r
 
  ~/releng/bin/create-composite.sh -r
  
Line 239: Line 238:
 
* Create mylyn-3.7.x-release job on the HIPP by cloning the previous release job
 
* Create mylyn-3.7.x-release job on the HIPP by cloning the previous release job
 
** Configure job to build from master branch, trigger downstream jobs on master branch, and run weekly
 
** Configure job to build from master branch, trigger downstream jobs on master branch, and run weekly
 +
** start a build so the composite sites will be populated
 
* Create a mylyn-3.7.x job at http://ci.mylyn.org/ and configure it to build from the master branch
 
* Create a mylyn-3.7.x job at http://ci.mylyn.org/ and configure it to build from the master branch
 +
* update default target of http://ci.mylyn.org/job/mylyn-all-snapshot/ to next Eclipse release
 +
* update targets of https://hudson.eclipse.org/mylyn/job/mylyn-integration/ and http://ci.mylyn.org/job/mylyn-3.20.x to have the last Eclipse major version, the next Eclipse major version, staging, and maintenance (when the maintenance repository exists), e.g. mars neon maintenance staging
  
 
== Add Bugzilla Versions and Milestones ==
 
== Add Bugzilla Versions and Milestones ==
Line 254: Line 256:
 
* ''major release'' Update release plans in https://projects.eclipse.org/projects/mylyn/documentation
 
* ''major release'' Update release plans in https://projects.eclipse.org/projects/mylyn/documentation
 
* Create release bug for the next release
 
* Create release bug for the next release
 +
* Add release to [https://calendar.google.com/calendar/embed?src=kq3ed9c0latktst29lrl8nffu0@group.calendar.google.com&ctz=America/Vancouver Mylyn calendar]
  
 
= Notes =
 
= Notes =
Line 260: Line 263:
 
* Most of the examples assume you are releasing Mylyn 3.6 and then preparing for the 3.7 release
 
* 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
 
* In this document, ''major release'' generally means anything other than a service release
 +
* A version of this document including instructions specific to Mylyn Incubator is available at https://wiki.eclipse.org/index.php?title=Mylyn/Release_Howto&oldid=404098 (search the page for "incubator")

Revision as of 18:03, 29 April 2016


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. Note: replace clone command with "git pull" if repository is already cloned.
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 checkout master
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
    • set to build from e_3_7_m_3_6_x branch
    • set BRANCH parameter passed to downstream builds
    • edit the build schedule so it won't build automatically after this point
  • 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 the downloads area.
    • Check that all Orbit bundles are tracked in approved CQs
    • 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

See Mylyn/Build_Infrastructure#Build_Target_Platforms to update versions of Eclipse Platform dependencies.

./extractVersionsFromUpdateSite.sh ../../org.eclipse.mylyn-target/mylyn-e4.4.target ~/downloads/tools/orbit/downloads/drops/R20150519210750/repository/

Copy the desired suggestions to the target file.

Build

  • If building from a branch, make sure that all needed changes are on the branch and that the o.e.m.all repository is up to date. It doesn't always update automatically.
  • Release builds (Hudson)
    • Check publish
    • Once the build is complete, check the test results from the downstream jobs
  • 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
     sdavis@build.eclipse.org:~/downloads/mylyn/discovery/org.eclipse.mylyn.discovery-3.12.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
     sdavis@build.eclipse.org:~/downloads/mylyn/discovery/org.eclipse.mylyn.discovery-3.13.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
find /home/data/httpd/download.eclipse.org/mylyn/drops/3.17.0/v20150909-1855/plugins/ -name "*.help*.jar" -not -name "*.source*"

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):
org.eclipse.mylyn.builds
org.eclipse.mylyn.docs
org.eclipse.mylyn.reviews
org.eclipse.mylyn.versions
  • Push tags
git submodule foreach git push --tags
git push --tags

Prepare Download Area

  • Log into Eclipse.org
ssh build.eclipse.org
  • Remove Old old RC builds (i.e. all builds other than the latest)
cd ~/downloads/mylyn/drops/3.17.0/
rm -rf v20150710-2256  v20150715-0010  v20150729-0011  v20150805-1738  v20150812-1640  v20150826-0009  v20150902-2226
  • 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/
~/releng/bin/update-metadata.sh
  • 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 composites for the release exist:
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 Releases 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 discovery label and URL in org.eclipse.mylyn-feature/feature.xml
  • 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
  • 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
  • Update the default value of the BRANCH parameter of http://ci.mylyn.org/view/Snapshots/job/update-simrel-contribution/ with the branches that should get the next Mylyn version, or disable the job if no SimRel will include this version. This will normally be "master" (contribute to the next release of Eclipse), but can have a space-delmited list of other eclipse versions to contribute to. As soon as the new Eclipse version is released in June, we need to include master and the new release branch (for example, "master Neon_maintenance").

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/releases/luna ~/downloads/mylyn/releases/mars
  • 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

Create Build Jobs

Add Bugzilla Versions and Milestones

Update Project Plan

Notes

  • 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
  • A version of this document including instructions specific to Mylyn Incubator is available at https://wiki.eclipse.org/index.php?title=Mylyn/Release_Howto&oldid=404098 (search the page for "incubator")

Back to the top