Of course, there really is no "build" of Ganymede, but only a copying of what is already available on each project's update site, to a central site.

Of course, there really is no "build" of Ganymede, but only a copying of what is already available on each project's update site, to a central site.

This central update site, naturally, is http://download.eclipse.org/releases/ganymede/. To get a sneak peek, point your Update Manager at http://download.eclipse.org/releases/ganymede/staging/.

This central update site, naturally, is http://download.eclipse.org/releases/ganymede/. To get a sneak peek, point your Update Manager at http://download.eclipse.org/releases/ganymede/staging/.

+

+

==Running a Build==

+

+

The Ganymatic runs automatically when it detects changes in CVS that warrant a new build. However, if you're impatient or want to test your latest contribution, you can kick a build yourself using the Cruise Control interface:

* Next, click the icon that looks like an arrow biting its tail. Onmouseover it says "Force build". [[Image:Cruise-Control-force-build-icon.gif]]

+

+

* Wait a minute or two, then go back to the main [http://build.eclipse.org/ganymede/ Ganymede dashboard], and wait for your build to complete.

==The Projects' Roles==

==The Projects' Roles==

Line 68:

Line 78:

http://www.eclipse.org/buckminster/schemas/common-1.0.xsd ,

http://www.eclipse.org/buckminster/schemas/common-1.0.xsd ,

http://www.eclipse.org/buckminster/schemas/rmap-1.0.xsd

http://www.eclipse.org/buckminster/schemas/rmap-1.0.xsd

+

+

A note on '''<sc:member''' semantics: please don't use an eclipse -dev mailing list, or any other email address that requires a subscription ... the builder will seldom be subscribed.

===Project Responsibilities===

===Project Responsibilities===

Line 83:

Line 95:

TBD: how to trigger a new build and how to sign off that the project M-bits are ready to use.

TBD: how to trigger a new build and how to sign off that the project M-bits are ready to use.

−

==The Central Ganymatic==

+

==The Production Ganymatic==

−

As of 2007/10/14, the Ganymede builds are being run once a day at 11pm Eastern, 8pm Pacific, 5am Europe, 11am China.

+

The Ganymede builds are triggered automatically when ever someone commits their site contributions to head. In some few cases, for example, if someone subsequently updates or fixes their own update site, but the sc files don't change, then you may have to "touch" your sc file and commit it, just to trigger a build, or, you can "manually" force a new build from the [http://build.eclipse.org:9777/dashboard/tab/builds Orbit Cruise Control page].

−

TBD: how to trigger a new build and how to sign off that the project M-bits are ready to use.

+

===Digests, P2 Metadata, Pack200 and Promotion===

+

The digest and P2 meta data are created every "build", so they should always be accurate.

+

But, the site is "packed" (with pack200) only once per day, overnight, since it takes about 2 hours.

−

===Releasing the Central Staging Bits===

+

The implication of this, is that before "promoting" a build, you need to make sure that the packing step has taken place on the latest files in staging. (There will be no pack200.gz files, if it has not ran, yet).

−

On build.eclipse.org as ~bfreeman, first run copyToRelease-1-plugins.sh. If that is successful, run copyToRelease-2-sitefiles.sh.

+

−

You may want to clean out all the existing files from the release directory before doing the copy (or you may not). If so, use copyToRelease-0-clean.sh

+

If it has not ran yet, and you want to promote, you can "manually" start the pack build from Cruisecontrol, and enjoy your favorite beverage while it cranks away.

−

==Running Ganymatic On Your Machine==

+

===Promoting a build from Staging area to Releases Area===

−

# Build a copy of Ganymatic (follow steps 1-4 below).

+

−

# Check out the org.eclipse.ganymede.sitecontributions and org.eclipse.ganymede.tools from /cvsroot/callisto

+

−

# Make sure you have a ganymatic.properties in your home directory. See examples in org.eclipse.ganymede.tools/examples

+

−

# Use ant to run the build.xml from org.eclipse.ganymede.tools

+

−

# The results (update site and website) are placed in the directories you specified in the ganymatic.properties file.

+

−

===Creating Ganymatic for Build.Eclipse.Org===

+

There is a script, in org.eclipse.ganymede.tools, called 'promote.sh' which performs the usual steps of copying 'staging' bits to 'releases' area. It should be executed from the org.eclipse.ganymede.tools directory.

−

To create the binaries for Ganymatic:

+

−

# Start with an Eclipse SDK with the latest version of Buckminster [http://www.eclipse.org/projects/project_summary.php?projectid=technology.buckminster] loaded.

+

It removes all the previous 'releases' files (which is appropriate for milestones, and the final release, but will have to be improved for the maintenance releases). After removal, it copies all the files from /releases/ganymede/staging "up to" /releases/ganymede. It also uses a sed script to modify URLs in the site.xml file that contain /releases/ganymede/staging to be shortened to /releases/ganymede. Then, it recreates the the digest.zip file, and the P2 metadata files. These partially have to be re-created because they contain some URLs inside (for the mirror script) which has to be modified from 'staging' to 'releases', but also since as a general principle, they should be recreated, so they are sure to reflect the contents of the 'new' site (even though, most of the time, the contents are identical to the 'old' site).

::It is recommended you create a directory called ''ganymedeConfig'' in your ''$HOME'' directory, and put your two customized files there, since several of the script files will look there automatically and use those files, if they exist.

+

+

::See other examples in [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ganymede.tools/examples/?root=Callisto org.eclipse.ganymede.tools/examples].

+

+

::Note, the reason for having your own customizations in a separate location (~/ganymedeConfig) is so that you can easily get a fresh copy of org.eclipse.ganymede.tools without "stepping on" your own customizations. Only the production build machine should depend on the property files located in the org.eclipse.ganymede.tools project.

+

+

:4. Use ant to run the build.xml from org.eclipse.ganymede.tools. Or, use [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ganymede.tools/do_ganymatic_on_build.eclipse.org_.sh?root=Callisto&view=log this script]:

+

+

{{codeblock|<nowiki>cd org.eclipse.ganymede.tools; \

+

/shared/ganymede/apps/apache-ant-1.7.0/bin/ant \

+

-Dganymatic.properties.file=/path/to/ganymatic.properties</nowiki>}}

+

+

:5. The results (update site and website) are placed in the directories you specified in the ganymatic.properties file. Email notification (if any) is also configured in the properties file.

+

+

===For Build.Eclipse.Org===

+

+

To create the binaries (headless assembly scripts and runtime) for Ganymatic:

+

+

:1. Start with an Eclipse 3.3 or 3.4 SDK with the [http://download.eclipse.org/tools/buckminster/updates latest version] of [http://www.eclipse.org/projects/project_summary.php?projectid=tools.buckminster Buckminster] 1.0 installed. You need the two features <i>org.eclipse.buckminster.core</i> and <i>org.eclipse.buckminster.pde</i>. Please note that Buckminster has a lot of optional features. Don't install all of them (some are even mutually exclusive).

:7 Unlike the process for your own local build machine, there should '''not''' be any user-defined customization used or required for running Ganymatic on build.eclipse.org. This is by design, so that anyone can take over running the builds on eclipse.org and get the same, repeatable result by simply checking out the org.eclipse.ganymede.tools project and running it (that is, it should not depend on what user id is running the process, for production builds).

+

+

:Additional tidbits

+

+

:: If interested in how it works, the 'headless.zip' is the main part of the buckminster code that does headless builds (composition) but it lacks the project specific information that is compiled into org.eclipse.dash.siteassembler jar, which is in the bin/buckminster directory, along with the rest of headless.zip.

+

+

:: Ever wonder why or when the bin/buckminster code should be regenerated? See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=227693 Bug 227693] but the short answer is whenever there are bug fixes to Buckminster, or the org.eclipse.dash.siteassembler changes.

* Open a new [https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=cross-project.inbox%40eclipse.org&product=Community&component=Cross-Project Cross-Project] or [https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=cross-project.inbox%40eclipse.org&product=Dash&component=Ganymatic Ganymatic] bug

* Open a new [https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=cross-project.inbox%40eclipse.org&product=Community&component=Cross-Project Cross-Project] or [https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=cross-project.inbox%40eclipse.org&product=Dash&component=Ganymatic Ganymatic] bug

Some of these patches may be required, depending on which versions of the Platform are being used, to have a perfectly reproducible build as the eclipse production machine. I just wanted a central place to document them, so I wouldn't lose the information.

+

+

* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=229019 bug 229019] contains a patch that allows jars with security exceptions to be identified. This patch was applied to the 3.3.2 version of update.core, exported from developer workspace (not built, per se) and used in place of the one that is used by default in the current Buckminster headless assembly application. The patch simply allows the jar with the error to be listed so it can be tracked down and fixed.

+

+

* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=226850 bug 226850] contains a patch that is required to get site optimizer to pack directories. Hopefully this will be in the final 3.4 platform, but if anyone is using a build prior to that, they would have to have this patch applied to get the jars packed.

Explanation

In addition to sending emails to project release engineers who are responsible for broken builds, there are three 'Eclipse Build' format RSS feeds available for project teams to monitor. More info on feeds: Getting Started Guide, Feed Schema.

Running a Build

The Ganymatic runs automatically when it detects changes in CVS that warrant a new build. However, if you're impatient or want to test your latest contribution, you can kick a build yourself using the Cruise Control interface:

${downloads}/webtools/milestones/site.xml: The location of the project's update site. It's more efficient to access the site via a file path than a url, but a url will work. ${downloads} refers to the root of the http://download.eclipse.org/ server.

Bjorn Freeman-Benson and bjorn.freeman-benson@eclipse.org: person to notify if this project is responsible for breaking the build. Feel free to have multiple people listed.

org.eclipse.wtp-sc: the unique identifier for this site contribution

org.eclipse.jpt.feature: The feature identifier. One per feature (of course). Features are listed one per <dependency .../> node.

2.0.0.v200706041905-7C5EGzE9RvTVniSrwnf4TgOPe3e9: The feature version. One per feature (of course). Buckminster (the technology Ganymatic is built on) has a number of ways to specify the version. Most projects will use a single fixed version here, although you can also have an empty string to mean "the latest version found on my update site".

Web and JEE Development: Categories for the Ganymede site.xml file; used to group the features.

A note on <sc:member semantics: please don't use an eclipse -dev mailing list, or any other email address that requires a subscription ... the builder will seldom be subscribed.

Project Responsibilities

Each Ganymede project's PMC and/or Project Leader is responsible to keep its own *.sc (site contribution) file up to date as the project generates new milestones and release candidates. The project's project leader will probably delegate to the project's release engineer(s).

Obviously, each project's own update site must already exist (and be working) at the file location or url specified in the site contribution file.

Typically, as projects move from milestone to milestone (or release candidate to release candidate) only the version identifiers (e.g. 1.0.0.v200706250000-77--CYQCCz-CoRPCCCH]) in the site contribution file will need to be changed. At other times, features might be added, removed, or renamed:

Adding a feature: add new <dependency> and <attribute> nodes

Removing a feature: remove the corresponding <dependency> and <attribute> nodes

TBD: how to trigger a new build and how to sign off that the project M-bits are ready to use.

The Production Ganymatic

The Ganymede builds are triggered automatically when ever someone commits their site contributions to head. In some few cases, for example, if someone subsequently updates or fixes their own update site, but the sc files don't change, then you may have to "touch" your sc file and commit it, just to trigger a build, or, you can "manually" force a new build from the Orbit Cruise Control page.

Digests, P2 Metadata, Pack200 and Promotion

The digest and P2 meta data are created every "build", so they should always be accurate.
But, the site is "packed" (with pack200) only once per day, overnight, since it takes about 2 hours.

The implication of this, is that before "promoting" a build, you need to make sure that the packing step has taken place on the latest files in staging. (There will be no pack200.gz files, if it has not ran, yet).

If it has not ran yet, and you want to promote, you can "manually" start the pack build from Cruisecontrol, and enjoy your favorite beverage while it cranks away.

Promoting a build from Staging area to Releases Area

There is a script, in org.eclipse.ganymede.tools, called 'promote.sh' which performs the usual steps of copying 'staging' bits to 'releases' area. It should be executed from the org.eclipse.ganymede.tools directory.

It removes all the previous 'releases' files (which is appropriate for milestones, and the final release, but will have to be improved for the maintenance releases). After removal, it copies all the files from /releases/ganymede/staging "up to" /releases/ganymede. It also uses a sed script to modify URLs in the site.xml file that contain /releases/ganymede/staging to be shortened to /releases/ganymede. Then, it recreates the the digest.zip file, and the P2 metadata files. These partially have to be re-created because they contain some URLs inside (for the mirror script) which has to be modified from 'staging' to 'releases', but also since as a general principle, they should be recreated, so they are sure to reflect the contents of the 'new' site (even though, most of the time, the contents are identical to the 'old' site).

So, to summarize, the actual mechanics are pretty simple: on build.eclipse.org, perform something like the following, saving the output in case you need to inspect it for errors, etc.

It is recommended you create a directory called ganymedeConfig in your $HOME directory, and put your two customized files there, since several of the script files will look there automatically and use those files, if they exist.

Note, the reason for having your own customizations in a separate location (~/ganymedeConfig) is so that you can easily get a fresh copy of org.eclipse.ganymede.tools without "stepping on" your own customizations. Only the production build machine should depend on the property files located in the org.eclipse.ganymede.tools project.

4. Use ant to run the build.xml from org.eclipse.ganymede.tools. Or, use this script:

5. The results (update site and website) are placed in the directories you specified in the ganymatic.properties file. Email notification (if any) is also configured in the properties file.

For Build.Eclipse.Org

To create the binaries (headless assembly scripts and runtime) for Ganymatic:

1. Start with an Eclipse 3.3 or 3.4 SDK with the latest version of Buckminster 1.0 installed. You need the two features org.eclipse.buckminster.core and org.eclipse.buckminster.pde. Please note that Buckminster has a lot of optional features. Don't install all of them (some are even mutually exclusive).

7 Unlike the process for your own local build machine, there should not be any user-defined customization used or required for running Ganymatic on build.eclipse.org. This is by design, so that anyone can take over running the builds on eclipse.org and get the same, repeatable result by simply checking out the org.eclipse.ganymede.tools project and running it (that is, it should not depend on what user id is running the process, for production builds).

Additional tidbits

If interested in how it works, the 'headless.zip' is the main part of the buckminster code that does headless builds (composition) but it lacks the project specific information that is compiled into org.eclipse.dash.siteassembler jar, which is in the bin/buckminster directory, along with the rest of headless.zip.

Ever wonder why or when the bin/buckminster code should be regenerated? See Bug 227693 but the short answer is whenever there are bug fixes to Buckminster, or the org.eclipse.dash.siteassembler changes.

See Also

Required Patches

Some of these patches may be required, depending on which versions of the Platform are being used, to have a perfectly reproducible build as the eclipse production machine. I just wanted a central place to document them, so I wouldn't lose the information.

bug 229019 contains a patch that allows jars with security exceptions to be identified. This patch was applied to the 3.3.2 version of update.core, exported from developer workspace (not built, per se) and used in place of the one that is used by default in the current Buckminster headless assembly application. The patch simply allows the jar with the error to be listed so it can be tracked down and fixed.

bug 226850 contains a patch that is required to get site optimizer to pack directories. Hopefully this will be in the final 3.4 platform, but if anyone is using a build prior to that, they would have to have this patch applied to get the jars packed.