Difference between revisions of "Papyrus/Papyrus Developer Guide/Release Process: How To"

Revision as of 11:51, 2 June 2015

The Papyrus project is built using Tycho with this releng project: Releng

Hudson Jobs

The Papyrus builds are started from Hudson. The following jobs on the Mars branch exist currently. There should always be the following jobs on each release branch:

• papyrus-Master : builds the main plug-ins of Papyrus
• papyrus-Master-Analysis : static analysis of the code, i.e. findBugs, sonar...
• papyrus-Master-Tests : builds the tests for the main plugins of Papyrus
• papyrus-Master-Tests-Failures : tests identified as failed, not regressions, kept to keep the main tests clean and without spams
• papyrus-Master-Developer : developer tools, such as debug views in eclipse, papyrus diagram code generator and building tools
• papyrus-Master-Extra : builds the "extra" plug-ins of Papyrus
• papyrus-Master-Extra-Tests : builds the tests for the "extra" plug-ins

See all the currently defined Papyrus jobs on the page : https://hudson.eclipse.org/papyrus/view/<Eclipse version> You can add the name of the eclipse release to find the associated jobs, i.e. Mars, Luna...

What is built?

Taking the example of "papyrus-Master", we use the releng's pom.xml files:

• top-pom-main.xml
• top-pom-main-tests.xml
• top-pom-extras.xml
• top-pom-extra-tests.xml

These files must include all features, plugins and update sites that must be built, either directly or indirectly.

The pom-xxx.xml file also specifies how to get the plug-ins and features that are to be built and specifies the update sites from which to retrieve the binary dependencies from the dependent projects.

Updating the pom-xxx.xml

The files reflects the dependencies on the other projects. So, it must be updated at least before each milestone, to make sure that the code that is built works with the latest versions of all the dependencies.

The easiest way to update the dependencies is to copy them from the aggregation build model, which all projects must fill in with the correct reference to their update site(s) and feature(s).

This model is in a project with the release name on the Eclipse Git:

• git://git.eclipse.org/gitroot/simrel/org.eclipse.simrel.build.git

Clone the simrel repository

Import the simrel project

There is a tool that copies most of the information automatically in this plug-in:

• (see the Papyrus developer tools)
• (see the org.eclipse.papyrus.releng.tools)

Install the releng tools

Update the dependencies of the selected poms

Choose the build model from the simrel project

The simrel model used to update the dependencies

Warning: don't forget to pull the last changes in order to build the correct state and verify that the branch built is the correct one (master or <Eclipse version>_maintenance, e.g. Luna_maintenance)

A few dependencies are not in the aggregation build model though, so they must be updated manually:

• Orbit : you can find the latest version listed on : http://download.eclipse.org/tools/orbit/downloads/

Finding dependencies

If you don't know where a particular plug-in or feature is located, the easiest way to find it is to search the Eclipse download area using "find" on build.eclipse.org. For example, to look for "org.eclipse.emf.compare" :

find /home/data/httpd/download.eclipse.org/modeling/emf/ -name 'org.eclipse.emf.compare_*'

Push

When pushing to the papyrus' gerrit you should use the standardized message :

• [Releng] Update dependencies for <Eclipse Version> <Milestone>

e.g. [Releng] Update dependencies for Mars M7

How to start a build?

Automatically

• Builds, master and maintenances, are run automatically every night, every day and each hour if there has been a commit.

Manually

Only committers in the Papyrus project can launch Papyrus build jobs from Hudson.

Go to the wanted page if you want to launch a selected build, e.g. https://hudson.eclipse.org/papyrus/view/Mars/

Then:

• In Hudson, click on Build Now, change the build parameters as needed (see #Build parameters), and click on Build.
• You can then click on the job name in the Build History section in the left column, and then on Console Output, to follow build progress in real time.

How to publish a build?

Automatically

Successful Nightly builds are automatically published to :

• http://download.eclipse.org/modeling/mdt/papyrus/updates/nightly/mars/

With the script

To publish a milestone or release from a build, you can use the manualPromote.sh for Luna, and manualPromote-mars.sh for Mars, script on: /opt/public/modeling/mdt/papyrus/manualPromote.sh Start this script, and fill in the parameters in the interactive script.

For example:

$ cd /opt/public/modeling/mdt/papyrus/
$ ./manualPromote.sh
-------------------- user parameters --------------------
mainBuildNumber (the number of the "papyrus-trunk-nightly" Hudson build from which to publish the main Papyrus plug-ins):
? 519
extrasBuildNumber (the number of the "papyrus-trunk-extra-nightly" Hudson build from which to publish the extra Papyrus plug-ins, or 0 to not publish):
? 43
testsBuildNumber (the number of the "papyrus-trunk-nightly-tests" Hudson build from which to publish the test results, or 0 to not publish):
? 93
version (e.g. "0.9.0"):
? 0.9.0
updateSite (e.g. "nightly/juno", "milestones/0.9/M5", "releases/indigo/0.8.1") :
? milestones/0.9/M5
Are you sure you want to publish with these parameters (yes|no)?
? yes

In the previous example, the script will:

• publish the main Papyrus plug-ins from papyrus-trunk-nightly build #519 to the Papyrus download in "drops/0.9.0" and the update site in "milestones/0.9/M5/main"
• publish the extra plug-ins from papyrus-trunk-extra-nightly build #43 to the Papyrus download in "drops/0.9.0" in the same build folder as the main build, and the update site in "milestones/0.9/M5/extra"
• publish the test results from papyrus-trunk-nightly-tests build #93 to the Papyrus download in "drops/0.9.0" in the same build folder as the main build
• make "milestones/0.9/M5" a composite update site, which contains "milestones/0.9/M5/main" and "milestones/0.9/M5/extra"
• enable p2 download statistics both on "milestones/0.9/M5/main" and "milestones/0.9/M5/extra"
• set the correct linux access rights on the new folders

Once the script is done, all you have left to do is to:

• Tag the build
• update the aggregation model if this build must be part of the simultaneous release

Manually

Stable builds are not automatically published. They should be first tested internally before publishing. For example, to publish the 1.1.0M6 milestone build:

• First, the build is on the update site nightly http://download.eclipse.org/modeling/mdt/papyrus/updates/nightly/mars/
• Then, install the build and test it manually
• Then, publish it using the script manualPromote.sh

Add a new update site with the new build to the parent composite (~/downloads/modeling/mdt/papyrus/updates/milestones/1.1/):

• update both the compositeContent.xml and compositeArtifacts.xml files of the update site (that are located in the parent of the folder to which you extracted the update site) to add a reference to your newly added update site
  • set the value of p2.timestamp to the result of "date +%s000"
  • increase the "size" attribute of the children element
  • add a "child" element inside the "children" element with a "location" set to the name of the folder (e.g "M6")
• Check that the new build appears on http://www.eclipse.org/papyrus/downloads/.

Builds can be hidden from this page before a release by modifying downloads-scripts.php in /downloads/ on git://git.eclipse.org/gitroot/www.eclipse.org/papyrus.git

• Tag the build

Simultaneous Release

If the build must be part of the simultaneous release, you must also:

• Use the B3 Aggregator (or a text editor if the modification is trivial) and push to the simrel's gerrit which path is : ssh://username@git.eclipse.org:29418/simrel/org.eclipse.simrel.build.git)

Usually, the only thing to change is the location (for example "milestones/1.1/M6/main"):

<repositories location="http://download.eclipse.org/modeling/mdt/papyrus/updates/milestones/1.1/M6/main" description="Papyrus">

Previous composite address

Updated composite address

Build parameters

Hudson builds expect these parameters:

• BUILD_ALIAS : the name of the release (0.9.0, 1.1.0M6, etc.); leave it blank for nightly and integration builds
• SIGN : whether to sign the update site (can take up to an hour on the Eclipse build server); mandatory for all builds except nightlies

Tagging

Releases should have a tag like 0.9.0, and milestones should have a tag like 0.9.0_M7.

Checking

Check simrel reports

After the simrel build, you can check the reports at :

• https://hudson.eclipse.org/simrel/job/simrel.build.repoReportsAndTests/lastSuccessfulBuild/artifact/test-report/reports-staging/reporeports/index.html

Check installations

Check installation from the simrel/staging update site at :

• http://download.eclipse.org/releases/staging (Master)
• http://download.eclipse.org/releases/maintenance (Maintenance)