Jump to: navigation, search

Difference between revisions of "MoDisco/Releng/How to Use"

 
(47 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
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?]].
 +
 +
== What is 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 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? ==
  
 
=== 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 [http://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.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.
+
* 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.
* Nightly build : go to [https://build.eclipse.org/hudson/job/cbi-modisco-nightly/ https://build.eclipse.org/hudson/job/cbi-modisco-nightly/]
+
* Nightly build : go to [https://hudson.eclipse.org/hudson/job/modisco-nightly/ https://hudson.eclipse.org/hudson/job/modisco-nightly/]
* Integration build : go to [https://build.eclipse.org/hudson/job/cbi-modisco-integration/ https://build.eclipse.org/hudson/job/cbi-modisco-integration/]
+
* Integration build : go to [https://hudson.eclipse.org/hudson/job/modisco-integration/ https://hudson.eclipse.org/hudson/job/modisco-integration/]
  
 
Then:
 
Then:
Line 19: Line 29:
 
== How to publish a build? ==
 
== How to publish a build? ==
 
=== Automatically ===
 
=== 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:
+
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:
  http://download.eclipse.org/modeling/gmt/modisco/downloads/drops/0.8.0/N200910061154
+
  http://download.eclipse.org/modeling/mdt/modisco/downloads/drops/0.8.0/N200910061154
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).
scp -r <commiterid>@build.eclipse.org:/opt/users/hudsonbuild/.hudson/jobs/cbi-modisco-integration/lastSuccessful/archive/build/* .
+
 
* Then, test the build locally
 
* Then, test the build locally
 
* Then, publish it:
 
* Then, publish it:
 
  ssh <commiterid>@build.eclipse.org
 
  ssh <commiterid>@build.eclipse.org
  cd /opt/users/hudsonbuild/.hudson/jobs/cbi-modisco-integration/lastSuccessful/archive/build/
+
  wget https://hudson.eclipse.org/hudson/job/modisco-integration/113/artifact/S201009291117.zip
  cp -r S200910061155 /home/data/httpd/download.eclipse.org/modeling/gmt/modisco/downloads/drops/0.8.0/
+
  unzip S201009291117.zip -d /home/data/httpd/download.eclipse.org/modeling/mdt/modisco/downloads/drops/0.9.0/
* Finally, for a release, update the update site with the new build:
+
Add a new update site with the new build to the composite:
  rm -rf /home/data/httpd/download.eclipse.org/modeling/gmt/modisco/update/release/*
+
* unzip the content in a new folder with the release number:
unzip S200910061155/MODISCO-Update-incubation-0.8.0M2.zip -d /home/data/httpd/download.eclipse.org/modeling/gmt/modisco/update/release/
+
  unzip MODISCO-Update-0.8.0M2.zip -d /home/data/httpd/download.eclipse.org/modeling/mdt/modisco/updates/milestones/0.10/M3
* Check that the new build appears on [http://www.eclipse.org/gmt/modisco/downloads/ http://www.eclipse.org/gmt/modisco/downloads/].
+
* update <code>compositeContent.xml</code> and <code>compositeArtifacts.xml</code> to add a reference to your newly added update site
 +
** 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 the archive site with the new build:
 +
** copy the drop folder (eg. "S200910061155") into <code>/home/data/httpd/archive.eclipse.org/modeling/mdt/modisco/downloads/drops/x.y.z</code>
 +
** 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 ===
 +
If the build must be part of the simultaneous release, you must also:
 +
* 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]).
 +
* 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]):
 
** '''N''': Nightly
 
** '''N''': Nightly
Line 47: Line 71:
 
** '''S''': Stable (for Milestones and Release Candidate builds)
 
** '''S''': Stable (for Milestones and Release Candidate builds)
 
** '''R''': Release
 
** '''R''': Release
* EXTRAFLAGS : flags that are passed to the build start script (see [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.dash/athena/org.eclipse.dash.commonbuilder/org.eclipse.dash.commonbuilder.releng/tools/scripts/start.sh?root=Technology_Project&view=markup start.sh]). Useful flags are:
+
* 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.
+
* 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''' : checkout the sources from a local directory instead of from the VCS. Since the Hudson nightly job is configured to check source changes before starting the build, this option is used to reuse Hudson's checked out sources.
+
 
 +
== Building locally ==
 +
 
 +
TODO
 +
 
 +
== Tagging ==
 +
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>
 +
Releases should have a tag like '''R0_7_1''', and milestones should have a tag like '''S0_9_0_M2'''.
 +
{{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>}}
 +
 
 +
[[Category:MoDisco]]
 +
[[Category:Releng]]
 +
 
 +
== Checking ==
 +
=== Check bundles ===
 +
Check that each bundle contains an about.html file:
 +
for f in $( ls *.jar ); do unzip -t $f | grep -q about.html || echo $f; done
 +
or for plug-ins in your workspace:
 +
find $workspaceRoot -name 'build.properties' | while read i; do grep -q about.html "$i" || echo "$i"; done
 +
 
 +
=== Check licenses ===
 +
find $workspaceRoot -type f -name 'license.html' | while read i; do md5 $i; done
 +
 
 +
=== Check Manifest.MF ===
 +
find $workspaceRoot -name 'MANIFEST.MF' | while read i; do grep -q Bundle-Vendor "$i" || echo "$i"; done
 +
find $workspaceRoot -name 'feature.xml' | while read i; do grep -q provider-name "$i" || echo "$i"; done
 +
 
 +
=== Check simrel reports ===
 +
for url in \
 +
    "http://build.eclipse.org/juno/simrel/reports/layoutCheck.txt" \
 +
    "http://build.eclipse.org/juno/simrel/reports/verifydiroutput/unsigned.txt" \
 +
    "http://build.eclipse.org/juno/simrel/reports/versionPatternCheck.txt" \
 +
    "http://build.eclipse.org/juno/simrel/reports/breedata.txt" \
 +
    "http://build.eclipse.org/juno/simrel/reports/pack200data.txt" \
 +
    "http://build.eclipse.org/juno/simrel/reports/nonUniqueVersions.txt"
 +
do
 +
  echo "checking $url"
 +
  curl -s -S "$url" | egrep 'modisco|facet'
 +
done
 +
 
 +
url="http://build.eclipse.org/juno/simrel/reports/licenseConsistency.html"
 +
echo "checking $url"
 +
curl -s -S $url > licenseConsistency
 +
n=$(cat licenseConsistency | grep -n "Features with matching" | sed 's/:.*//')
 +
cat licenseConsistency | head -n $n | egrep 'modisco|facet'
 +
 
 +
url="http://build.eclipse.org/juno/simrel/reports/featureNames.html"
 +
echo "checking $url"
 +
curl -s -S $url > featureNames
 +
n=$(cat featureNames | grep -n "Probably correct names" | sed 's/:.*//')
 +
cat featureNames | head -n $n | egrep 'modisco|facet'
 +
 
 +
url="http://build.eclipse.org/juno/simrel/reports/bundleNames.html"
 +
echo "checking $url"
 +
curl -s -S $url > bundleNames
 +
n=$(cat bundleNames | grep -n "Probably correct bundle name" | sed 's/:.*//')
 +
cat bundleNames | head -n $n | egrep 'modisco|facet'
 +
 
 +
url="http://build.eclipse.org/juno/simrel/reports/providerNames.html"
 +
echo "checking $url"
 +
curl -s -S $url > providerNames
 +
n=$(cat providerNames | grep -n "Probably using correct provider name" | sed 's/:.*//')
 +
cat providerNames | head -n $n | egrep 'modisco|facet'
 +
 
 +
url="http://build.eclipse.org/juno/simrel/reports/copyrights.html"
 +
echo "checking $url"
 +
curl -s -S $url > copyrights
 +
n=$(cat copyrights | grep -n "Features with copyrights that are probably ok" | sed 's/:.*//')
 +
cat copyrights | head -n $n | egrep 'modisco|facet'
 +
 
 +
url="http://build.eclipse.org/juno/simrel/reports/esdata.txt"
 +
echo "checking $url"
 +
curl -s -S $url > esdata
 +
n=$(cat esdata | grep -n "Bundles without an Eclipse-SourceReference" | sed 's/:.*//')
 +
cat esdata | tail -n +$n | egrep 'modisco|facet'

Latest revision as of 10:25, 9 May 2012

The MoDisco project is built using Buckminster, with this releng project. (for old Athena build, see this page)

For more explanation about how the build process works, see also How it Works?.

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

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 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:

http://download.eclipse.org/modeling/mdt/modisco/downloads/drops/0.8.0/N200910061154

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

With a script

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

Manually

Stable, Maintenance and Release 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 (from Hudson, or using wget or scp for example).
  • Then, test the build locally
  • Then, publish it:
ssh <commiterid>@build.eclipse.org
wget https://hudson.eclipse.org/hudson/job/modisco-integration/113/artifact/S201009291117.zip
unzip S201009291117.zip -d /home/data/httpd/download.eclipse.org/modeling/mdt/modisco/downloads/drops/0.9.0/

Add a new update site with the new build to the composite:

  • unzip the content in a new folder with the release number:
unzip MODISCO-Update-0.8.0M2.zip -d /home/data/httpd/download.eclipse.org/modeling/mdt/modisco/updates/milestones/0.10/M3
  • update compositeContent.xml and compositeArtifacts.xml to add a reference to your newly added update site
    • set the value of p2.timestamp to the result of "date +%s000"
  • You can enable download stats on the repository by running addDownloadStats.sh on the update site
  • Check that the new build appears on http://www.eclipse.org/MoDisco/downloads/.
  • Builds can be hidden from this page before a release by modifying downloads-scripts.php in www/MoDisco on :pserver:anonymous@dev.eclipse.org:/cvsroot/org.eclipse
  • Update the archive site with the new build:
    • copy the drop folder (eg. "S200910061155") into /home/data/httpd/archive.eclipse.org/modeling/mdt/modisco/downloads/drops/x.y.z
    • update /home/data/httpd/archive.eclipse.org/modeling/mdt/modisco/downloads/index.html with a link to the newly added update zip
  • Tag the build
  • Wipe out the Hudson workspace to free up room on the server.

Simultaneous Release

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

Build parameters

Hudson builds expect these parameters:

  • BUILDTYPE : the kind of build, represented by a code letter (see this page):
    • N: Nightly
    • I: Integration
    • M: Maintenance (NOT milestone)
    • S: Stable (for Milestones and Release Candidate builds)
    • R: Release
  • BUILD_ALIAS : the name of the release (0.8.0, 0.9.0M1, etc.); blank for nightly and integration builds
  • SIGN_UPDATE_SITE : whether to sign the update site (takes about an hour on the Eclipse build server); mandatory for releases
  • VERSION : the version being built. Dictates in which folder the build will be placed under the download "drops" folder.
  • 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.

Building locally

TODO

Tagging

To tag a release, use this script: tag.sh.
Releases should have a tag like R0_7_1, and milestones should have a tag like S0_9_0_M2.

Warning2.png
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 v0.7.1

Checking

Check bundles

Check that each bundle contains an about.html file:

for f in $( ls *.jar ); do unzip -t $f | grep -q about.html || echo $f; done

or for plug-ins in your workspace:

find $workspaceRoot -name 'build.properties' | while read i; do grep -q about.html "$i" || echo "$i"; done

Check licenses

find $workspaceRoot -type f -name 'license.html' | while read i; do md5 $i; done

Check Manifest.MF

find $workspaceRoot -name 'MANIFEST.MF' | while read i; do grep -q Bundle-Vendor "$i" || echo "$i"; done
find $workspaceRoot -name 'feature.xml' | while read i; do grep -q provider-name "$i" || echo "$i"; done

Check simrel reports

for url in \
   "http://build.eclipse.org/juno/simrel/reports/layoutCheck.txt" \
   "http://build.eclipse.org/juno/simrel/reports/verifydiroutput/unsigned.txt" \
   "http://build.eclipse.org/juno/simrel/reports/versionPatternCheck.txt" \
   "http://build.eclipse.org/juno/simrel/reports/breedata.txt" \
   "http://build.eclipse.org/juno/simrel/reports/pack200data.txt" \
   "http://build.eclipse.org/juno/simrel/reports/nonUniqueVersions.txt"
do
  echo "checking $url"
  curl -s -S "$url" | egrep 'modisco|facet'
done
url="http://build.eclipse.org/juno/simrel/reports/licenseConsistency.html"
echo "checking $url"
curl -s -S $url > licenseConsistency
n=$(cat licenseConsistency | grep -n "Features with matching" | sed 's/:.*//')
cat licenseConsistency | head -n $n | egrep 'modisco|facet'
url="http://build.eclipse.org/juno/simrel/reports/featureNames.html"
echo "checking $url"
curl -s -S $url > featureNames
n=$(cat featureNames | grep -n "Probably correct names" | sed 's/:.*//')
cat featureNames | head -n $n | egrep 'modisco|facet'
url="http://build.eclipse.org/juno/simrel/reports/bundleNames.html"
echo "checking $url"
curl -s -S $url > bundleNames
n=$(cat bundleNames | grep -n "Probably correct bundle name" | sed 's/:.*//')
cat bundleNames | head -n $n | egrep 'modisco|facet'
url="http://build.eclipse.org/juno/simrel/reports/providerNames.html"
echo "checking $url"
curl -s -S $url > providerNames
n=$(cat providerNames | grep -n "Probably using correct provider name" | sed 's/:.*//')
cat providerNames | head -n $n | egrep 'modisco|facet'
url="http://build.eclipse.org/juno/simrel/reports/copyrights.html"
echo "checking $url"
curl -s -S $url > copyrights
n=$(cat copyrights | grep -n "Features with copyrights that are probably ok" | sed 's/:.*//')
cat copyrights | head -n $n | egrep 'modisco|facet'
url="http://build.eclipse.org/juno/simrel/reports/esdata.txt"
echo "checking $url"
curl -s -S $url > esdata
n=$(cat esdata | grep -n "Bundles without an Eclipse-SourceReference" | sed 's/:.*//')
cat esdata | tail -n +$n | egrep 'modisco|facet'