The MoDisco project is built using [[Athena Common Build]], with this [http://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng releng project].

+

The MoDisco project is built using [[Buckminster]], with this [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng.buckminster releng project]. <span style="color:#606060">(for old Athena build, see [[MoDisco/Releng/Athena/How_to_Use|this page]])</span>

For more explanation about how the build process works, see also [[MoDisco/Releng/How_it_Works|How it Works?]].

For more explanation about how the build process works, see also [[MoDisco/Releng/How_it_Works|How it Works?]].

== What is built? ==

== What is built? ==

−

In the build.properties file of the releng project, the "mainFeatureToBuildID" property defines the feature that must be built. This feature must include all other features that must be built.

+

<code>org.eclipse.gmt.modisco.all</code> is the feature that is built (defined in buckminster.cspec).

+

This feature must include all other features that must be built.

−

The releng project contains map files, which specify how to get the plugins and features that are to be built. For each plugin or feature, the map defines its location on a version control system (CVS and SVN are supported), and the version that must be used. Nightlies ignore the version information, and always build from head, whereas other types of builds checkout the tag or branch specified in the map.

+

The releng project contains a Buckminster rmap, which specifies how to get the plugins and features that are to be built. For each plugin or feature, the map defines its location on a version control system (CVS, SVN), and the version that must be used.

== How to start a build? ==

== How to start a build? ==

Line 12:

Line 13:

=== Automatically ===

=== Automatically ===

−

* Nightly builds are run every 6 hours everyday, at 02:10, 08:10, 14:10 and 20:10 [http://en.wikipedia.org/wiki/Eastern_Time_Zone EST], if the [http://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco MoDisco SVN] changed since the last build.

+

* Nightly builds are run every 6 hours everyday, at 02:10, 08:10, 14:10 and 20:10 [http://en.wikipedia.org/wiki/Eastern_Time_Zone EST], if the [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco MoDisco SVN] changed since the last build.

−

* Integration builds are started every Tuesday at 06:36 EST (11:36 or 12:36 GMT), if the [http://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng releng project] changed since the last integration build. That is, a new integration build will only be triggered when a map file changed.

+

* Integration builds are started manually.

=== Manually ===

=== Manually ===

* Only committers in the MoDisco project, and members of the Callisto-dev group can launch MoDisco build jobs from Hudson.

* Only committers in the MoDisco project, and members of the Callisto-dev group can launch MoDisco build jobs from Hudson.

Successful '''N'''ightly and '''I'''ntegration builds are automatically published to download.eclipse.org. For example, a nightly build for version 0.8.0, created on October 6 2009 at 11:54 EST would be published to:

Successful '''N'''ightly and '''I'''ntegration builds are automatically published to download.eclipse.org. For example, a nightly build for version 0.8.0, created on October 6 2009 at 11:54 EST would be published to:

These builds can then be seen and downloaded from [http://www.eclipse.org/gmt/modisco/downloads/ http://www.eclipse.org/gmt/modisco/downloads/], where additional information is available (test results, build log, build configuration, build dependencies).

+

These builds can then be seen and downloaded from [http://www.eclipse.org/MoDisco/downloads/ http://www.eclipse.org/MoDisco/downloads/], where additional information is available (test results, build log).

+

+

=== With a script ===

+

Run <code>/opt/public/modeling/mdt/modisco/manualPromote.sh</code> and fill in the parameters.

=== Manually ===

=== Manually ===

'''S'''table, '''M'''aintenance and '''R'''elease builds are not automatically published. They should be first tested internally before publishing. For example, to publish the 0.8.0M2 milestone build:

'''S'''table, '''M'''aintenance and '''R'''elease builds are not automatically published. They should be first tested internally before publishing. For example, to publish the 0.8.0M2 milestone build:

−

* First, fetch the build archive to test:

+

* First, fetch the build archive to test (from Hudson, or using <code>wget</code> or <code>scp</code> for example).

* You can enable download stats on the repository by running [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng/serverConfiguration/addDownloadStats.sh addDownloadStats.sh]on the update site

+

* update <code>compositeContent.xml</code> and <code>compositeArtifacts.xml</code> to add a reference to your newly added update site

−

* Check that the new build appears on [http://www.eclipse.org/gmt/modisco/downloads/ http://www.eclipse.org/gmt/modisco/downloads/].

+

** set the value of p2.timestamp to the result of "<code>date +%s000</code>"

+

* You can enable download stats on the repository by running [http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng.buckminster/serverConfiguration/addDownloadStats.sh addDownloadStats.sh] on the update site

+

* Check that the new build appears on [http://www.eclipse.org/MoDisco/downloads/ http://www.eclipse.org/MoDisco/downloads/].

+

* Builds can be hidden from this page before a release by modifying <code>downloads-scripts.php</code> in <code>www/MoDisco</code> on <code>:pserver:anonymous@dev.eclipse.org:/cvsroot/org.eclipse</code>

** update <code>/home/data/httpd/archive.eclipse.org/modisco/downloads/index.html</code> with a link to the newly added update zip

+

** update <code>/home/data/httpd/archive.eclipse.org/modeling/mdt/modisco/downloads/index.html</code> with a link to the newly added update zip

+

* [[#Tagging|Tag the build]]

+

* [https://hudson.eclipse.org/hudson/job/modisco-integration/wipeOutWorkspace Wipe out the Hudson workspace] to free up room on the server.

=== Simultaneous Release ===

=== Simultaneous Release ===

−

If the build must be part of the simultaneous release, there are a few more steps to follow:

+

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

−

* Publish the update site to <code>/home/data/httpd/download.eclipse.org/modeling/gmt/modisco/updates/staging</code>

+

* Use the [[Eclipse_b3/aggregator/manual|B3 Aggregator]] (or a text editor if the modification is trivial) to [[Indigo/Contributing_to_Indigo_Build|update the build model for the aggregator]] ([http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.indigo.build/?root=Callisto after checking it out from CVS]).

−

* Use the [http://www.eclipse.org/modeling/amalgam/downloads/?project= DSL Toolkit] to [[Helios/Contributing_to_Helios_Build|update the build model for the aggregator]] ([http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.helios.build/?root=Callisto after checking it out from CVS]).

+

* Open juno.b3aggr in the B3 Aggregator editor, right-click on the first root node and select '''Validate Aggregation'''. Check in the error log that there are no errors.

== Build parameters ==

== Build parameters ==

Hudson builds expect these parameters:

Hudson builds expect these parameters:

−

* PROJECTID : modeling.gmt.modisco : no reason to change this

−

* VERSION : the version being built, must also be set in the [http://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng releng project]'s promote-N.properties and promote-I.properties.

* BUILDTYPE : the kind of build, represented by a code letter (see [http://www.eclipse.org/modeling/downloads/build-types.php this page]):

* BUILDTYPE : the kind of build, represented by a code letter (see [http://www.eclipse.org/modeling/downloads/build-types.php this page]):

* BUILD_ALIAS : the name of the release (0.8.0, 0.9.0M1, etc.); blank for nightly and integration builds

−

** '''-buildAlias''' : for release, maintenance and stable builds, use this option to give a more meaningful name to the build. For example, add <code>-buildAlias 0.8.0M2</code> to get "MODISCO-SDK-incubation-0.8.0M2.zip" instead of "MODISCO-SDK-incubation-S200910070943.zip".

+

* SIGN_UPDATE_SITE : whether to sign the update site (takes about an hour on the Eclipse build server); mandatory for releases

−

** '''-forceContextQualifier''' : force the ".qualifier" part of a plugin version number to a specific string.

+

* VERSION : the version being built. Dictates in which folder the build will be placed under the download "drops" folder.

−

** '''-fetchTag''' : Force a specific tag to be used when pulling sources from the VCS. For example, use <code>-fetchTag HEAD</code> to build from HEAD instead of from the versions specified in the releng project's map files ([https://bugs.eclipse.org/bugs/show_bug.cgi?id=292157 doesn't seem to work with SVN maps]).

+

* PROJRELENGROOT : The path on the SVN (trunk, branch or tag) from which to take the version of the releng project that must be used for this build.

−

** '''-localSourceCheckoutDir''' : get the sources from a local directory instead of from the VCS. The nightly build job script is configured to checkout sources from the head of the trunk, instead of using what's indicated in the maps. This option is then used to indicate the checked out sources directory.

+

== Building locally ==

== Building locally ==

−

First, checkout these projects into your workspace (you can import [http://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng/psf/modiscoReleng.psf this team project set]):

* Set all the <code>JAVA*_HOME</code> properties to the location of your JDK 6 install (eg: <code>/usr/lib/jvm/java-1.6.0-openjdk</code> or <code>C:/Program Files/Java/jdk1.6.0_16</code>)

+

To tag a release, use this script: [https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/releng/trunk/org.eclipse.gmt.modisco.releng.buckminster/utils/tag.sh tag.sh].<br>

−

* Set the <code>downloadsDir</code> property to a writable directory (eg: <code>/tmp/build/downloads</code> or <code>C:/temp/build/downloads</code>)

+

Releases should have a tag like '''R0_7_1''', and milestones should have a tag like '''S0_9_0_M2'''.

−

* change the <code>dependencyURLs</code> with the Eclipse SDK zip specific to your platform

+

{{warning|Tag names|Since the tag name is used as a bundle qualifier by PDE Build, it should not contain periods. For example, use '''R0_7_1''' instead of <s>v0.7.1</s>}}

−

Additionally, you should change all the <code>dependencyURLs</code> to point to one of your local Eclipse mirrors, to avoid saturating the main Eclipse download server, and getting extremely slow downloads.

+

[[Category:MoDisco]]

+

[[Category:Releng]]

−

Alternatively, you can download the dependencies manually and put them in your <code>downloadsDir</code>. The build will then use the files you provided instead of downloading them itself.

* Prepend <code>C:\cygwin\bin</code> to the <code>%Path</code> variable (open '''System properties''', click on '''Environment Variables...''', and change the '''Path''' variable so that it reads something like:

+

−

C:\cygwin\bin;%SystemRoot%\system32;%SystemRoot%;...

+

−

* Build from local sources instead of fetching from maps (see [[#Building from local sources]])

+

−

* If the build complains it can't find some tool, then install it into Cygwin by re-running Cygwin's <code>setup.exe</code>

+

−

* Spaces in the path of the JDK cause problems. There are several possible solutions:

+

−

** Use the "8.1" form of the path: (eg: "c:/progra~1/Java/jdk1.6.0_16"). You can find it by "dir /x" (thanks to Nick Boldt for this tip!).

+

−

** (Re-)install your JDK in a path not containing spaces

+

−

** Make a directory junction like this (on Windows Vista or 7):

+

−

C:\>mklink /J Java "C:\Program Files\Java\jdk1.6.0_16"

+

−

Junction created for Java <<===>> C:\Program Files\Java\jdk1.6.0_16

+

−

And then set the <code>JAVA*_HOME</code> variables to <code>C:/Java</code> in the <code>build.properties</code>.

+

−

* If tests seem to cause problems, you can disable them by removing <code>buildTests</code> and <code>test</code> from <code>build.steps</code> (and launch tests manually).

+

−

===== Caveat =====

+

−

* pack200 is not yet supported on Windows (http://bugs.eclipse.org/268405)

+

−

* running headless JUnit tests is not yet supported on Windows either (http://bugs.eclipse.org/268420)

+

−

=== Building from local sources ===

+

=== Check simrel reports ===

−

You can set the <code>localSourceCheckoutDir</code> in the <code>build.properties</code> to a directory where you already have all the MoDisco sources. This directory should contain a "plugins/" and a "features/" directory.

To avoid having to do a manual <code>svn export</code> before each build, you can use links on Linux or directory junctions on Windows to link both "plugins" and "features" to the root of your workspace:

What is built?

org.eclipse.gmt.modisco.all is the feature that is built (defined in buckminster.cspec).
This feature must include all other features that must be built.

The releng project contains a Buckminster rmap, which specifies how to get the plugins and features that are to be built. For each plugin or feature, the map defines its location on a version control system (CVS, SVN), and the version that must be used.

How to start a build?

Automatically

Nightly builds are run every 6 hours everyday, at 02:10, 08:10, 14:10 and 20:10 EST, if the MoDisco SVN changed since the last build.

Integration builds are started manually.

Manually

Only committers in the MoDisco project, and members of the Callisto-dev group can launch MoDisco build jobs from Hudson.

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 and Integration builds are automatically published to download.eclipse.org. For example, a nightly build for version 0.8.0, created on October 6 2009 at 11:54 EST would be published to: