Difference between revisions of "RAP/Build Process"

From Eclipsepedia

< RAP
Jump to: navigation, search
(Procedure for release builds)
(27 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
=== Hudson Builds ===
 
=== Hudson Builds ===
  
We have two build jobs at the Eclipse.org Hudson:
+
Build jobs at the Eclipse.org Hudson:
* [https://hudson.eclipse.org/hudson/job/rap-runtime/ rap-runtime]
+
 
* [https://hudson.eclipse.org/hudson/job/rap-tooling/ rap-tooling]
+
{| border="1"
 +
|-
 +
! RAP 1.5 !! RAP 2.0 !! RAP 2.x (head)
 +
|-
 +
| [https://hudson.eclipse.org/hudson/job/rap-1.5-runtime/ rap-1.5-runtime]
 +
| [https://hudson.eclipse.org/hudson/job/rap-2.0-runtime/ rap-2.0-runtime]
 +
| [https://hudson.eclipse.org/hudson/job/rap-head-runtime/ rap-head-runtime]
 +
|-
 +
| [https://hudson.eclipse.org/hudson/job/rap-1.5-tools/ rap-1.5-tools]
 +
| [https://hudson.eclipse.org/hudson/job/rap-2.0-tools/ rap-2.0-tools]
 +
| [https://hudson.eclipse.org/hudson/job/rap-head-tools/ rap-head-tools]
 +
|-
 +
| [https://hudson.eclipse.org/hudson/job/rap-1.5-incubator/ rap-1.5-incubator]
 +
|
 +
| [https://hudson.eclipse.org/hudson/ rap-head-incubator-COMPONENT_NAME]
 +
|}
  
 
The base directory for our builds is <code>/shared/rt/rap</code> on <code>build.eclipse.org</code>.
 
The base directory for our builds is <code>/shared/rt/rap</code> on <code>build.eclipse.org</code>.
  
=== Procedure for Milestone builds ===
+
=== Nightly Builds ===
  
* Tag CVS
+
We produce p2 repositories from our nightly builds:
** Tag everything that is contained in the <code>rt/org.eclipse.rap</code> module, pattern: <code>vYYYYMMDD_R12-Mx</code>
+
* http://download.eclipse.org/rt/rap/nightly/runtime/
*** You may need to increase the CVS connection timeout in <em>Preferences -> Team -> CVS -> Connection</em> tab (120 s seem to work)
+
* http://download.eclipse.org/rt/rap/nightly/tooling/
  
* Prepare new base platform in <code>/shared/rt/rap/base-platforms</code> (see <code>/shared/rt/rap/README</code>)
+
These p2 repositories are updated by a cron job:
** Copy base platform, extract it into a new directory
+
/shared/rt/rap/scripts/publish-nightly-build.sh
** Copy <code>com.ibm.icu.base</code> and include the bundles into the base platform
+
This job is run by rsternber's crontab.
** Copy Equinox SDK from and include the following bundles into the base platform:
+
*** <code>org.eclipse.equinox.servletbridge</code>
+
*** <code>org.eclipse.equinox.servletbridge.extensionbundle</code>
+
*** <code>org.eclipse.equinox.http.servletbridge</code>
+
** Provide Servlet 3.0 API
+
*** Copy <code>javax.servlet</code> 3.0 from [http://download.eclipse.org/tools/orbit/downloads/ Orbit] and include the bundles into the base platform
+
** Provide the dependencies for Mockito
+
*** Copy <code>org.objenesis</code> 1.0 from [http://download.eclipse.org/tools/orbit/downloads/ Orbit] and include the bundles into the base platform
+
*** <code>org.hancrest</code> should already be contained in the Eclipse Platform and thus there is no need to copy it
+
** Copy <code>org.json</code> 1.0.0 from Orbit into the base platform
+
*** The bundle can be found on build.eclipse.org using this path: /home/data/httpd/download.eclipse.org/tools/orbit/downloads/drops/R20110523182458/repository/plugins
+
** We used to delete all junit4 bundles from the plugins folder, probably not needed anymore (?)
+
  
* Configure the hudson jobs to use the new base platform
+
=== Procedure for Milestone builds ===
 
+
* Build runtime and tooling
+
** Set parameter <code>BUILD_TYPE</code> to <code>Mx</code> for milestone builds, <code>RCx</code> for release candidates, or <code>R</code> for release builds
+
** Set parameter <code>CVS_TAG</code> to the new tag (see above). DO NOT build milestones from HEAD
+
  
* Copy a <code>notice.html</code> and <code>epl-v10.html</code> into the root directory (eclipse) of the produced zip files (see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=347659 bug 347659])
+
* Prepare new base platform in <code>/shared/rt/rap/base-platforms</code> (see <code>HOWTO</code> file)
 
+
* Configure pom.xml files to include the new base platform
* Sign and upload files. This is currently done by the <code>publish.sh</code> script in <code>org.eclipse.rap.releng</code>
+
** <code>releng/org.eclipse.rap.build/pom.xml</code> (RAP Runtime)
 +
** <code>releng/org.eclipse.rap.target.build/pom.xml</code> (RAP Runtime)
 +
** <code>releng/org.eclipse.rap.tools.build/pom.xml</code> (RAP Tools)
 +
* Build RAP Runtime and RAP Tools with <code>BUILD_TYPE</code> = <code>S</code> for stable builds (these will be signed)
 +
* Move repositories to download area (see <code>/shared/rt/rap/publish/</code>)
 +
* Contribute repositories to simrel aggregator
 +
* Add tag to git repositories
 +
** <code>TAG=1.5.0-Mx-YYYYMMDD</code>
 +
** <code>git tag -a -m "$TAG" -s $TAG</code> (note: -s creates a signed tag)
 +
** <code>git push --tags origin</code>
  
 
==== Publishing ====
 
==== Publishing ====
  
 
* Finalize New & Noteworthy
 
* Finalize New & Noteworthy
* Update web site: new & noteworthy, downloads page, add links to previous version to archive page
+
* Update web site: builds.xml and arrivals sidebar
 
* Scan Bugzilla for open bugs that are targeted at the milestone or bugs that are still open but solved, verify target version of closed bugs
 
* Scan Bugzilla for open bugs that are targeted at the milestone or bugs that are still open but solved, verify target version of closed bugs
 +
* Update composite repositories for runtime and tools
 +
* Update rap/targets/ files
 +
* [1.5 only] Update rap/latest-stable/{runtime/tooling} repositories to redirect to new repo (for compatibility with 1.4 tooling)
 
* Notify the newsgroup
 
* Notify the newsgroup
 
* Announce via Blog
 
* Announce via Blog
 
* Re-deploy demo applications (in oder to demonstrate the new features from the milestone)
 
* Re-deploy demo applications (in oder to demonstrate the new features from the milestone)
 +
 +
* Publish RWT bundles in the [[RAP/Maven_Central | Maven Central repository]].
  
 
=== Procedure for release builds ===
 
=== Procedure for release builds ===
Line 61: Line 74:
 
* Check copyright year and version number of JavaDoc (search for "JavaDoc" in <code>org.eclipse.rap.releng/tooling/customTargets.xml</code>)
 
* Check copyright year and version number of JavaDoc (search for "JavaDoc" in <code>org.eclipse.rap.releng/tooling/customTargets.xml</code>)
 
* Move old builds to archive (<code>dev.eclipse.org:/home/data/httpd/archive.eclipse.org/rt/rap/downloads</code>), update archive page
 
* Move old builds to archive (<code>dev.eclipse.org:/home/data/httpd/archive.eclipse.org/rt/rap/downloads</code>), update archive page
* Update the P2-repository URLs of install target action (see class o.e.r.ui.internal.intro.target.InstallTargetDialog)
+
* Update the RAP-tooling entry in the [http://marketplace.eclipse.org/content/rich-ajax-platform-rap-tooling Eclipse Marketplace] and in the Yoxos Marketplace. They should point to the latest release.
* Update the RAP-tooling entry in the [http://marketplace.eclipse.org/content/rich-ajax-platform-rap-tooling Eclipse Marketplace] and in the Yoxos Marketplace. They should point to the latest release. (Beyhan)
+
 
* Redirect rap/latest-release/{runtime/tooling} repositories
 
* Redirect rap/latest-release/{runtime/tooling} repositories
 
* notify newsgroup and mailing list
 
* notify newsgroup and mailing list
 +
* use the portal to review project metadata that is displayed in the "About this Project" page (i.e. update release train name in description text)
 +
* Add p2.stats to artifact.xml
 +
* Add p2 mirror URLs to artifact.xml
 +
 +
* Check <code>notice.html</code> and <code>epl-v10.html</code> files for updates
 +
* Make sure <code>notice.html</code> and <code>epl-v10.html</code> files are included in the download zip files (see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=347659 bug 347659])
 +
 +
* Publish RWT bundles in the [[RAP/Maven_Central | Maven Central repository]].
 +
 +
==== Eclipse Marketplace ====
 +
 +
Make sure the RAP Tools are uploaded to the Eclipse market place.
  
 
=== Simultaneous Release ===
 
=== Simultaneous Release ===
  
* [https://hudson.eclipse.org/hudson/view/Repository%20Aggregation/job/indigo.runAggregator/ indigo aggregator]
+
* [https://hudson.eclipse.org/hudson/job/simrel.juno.runAggregator/ Juno Aggregator]
 +
* [https://hudson.eclipse.org/hudson/job/simrel.kepler.runaggregator/ Kepler Aggregator]
 
* [[SimRel/Simultaneous_Release_FAQ|Simultaneous_Release_FAQ]]
 
* [[SimRel/Simultaneous_Release_FAQ|Simultaneous_Release_FAQ]]
 +
 +
=== RAP Incubator Builds ===
 +
 +
In order to help early adopters consuming the work from the RAP Incubator project, we are running a set of automated builds from Git HEAD for all [http://www.eclipse.org/rap/incubator/ RAP Incubator Projects]. Every component has its own build that must follow some common naming conventions.
 +
 +
* Every RAP Incubator Component has a <code>COMPONENT_NAME</code>, that is used to find the necessary build scripts, features, etc.
 +
* Every component has its own Git repository <code>org.eclipse.rap.incubator.COMPONENT_NAME.git</code> at [http://git.eclipse.org/c/rap/incubator/ git.eclipse.org/c/rap/incubator/].
 +
* The build is based on Tycho and uses the RAP Incubator parent [http://git.eclipse.org/c/rap/incubator/org.eclipse.rap.incubator.releng.git/tree/releng/org.eclipse.rap.incubator.releng/pom.xml releng/org.eclipse.rap.incubator.releng/pom.xml].
 +
* The main build project <code>releng/org.eclipse.rap.COMPONENT_NAME.build</code> of the component contains the <code>pom.xml</code> that is used to build the entire component. In addition to that, it has
 +
** a <code>repository/</code> sub-directory with an additional pom that creates the final p2 repository of the component.
 +
* There is a main feature <code>features/org.eclipse.rap.COMPONENT_NAME.feature</code> that assembles everything that is used by a potential consumer.
 +
 +
Every build creates an independent p2 repository. All repositories are available on the build server at
 +
 +
<code>/shared/rt/rap/incubator/nightly/COMPONENT_NAME</code>
 +
 +
At the moment, we are running builds for the following components
 +
 +
* clientscripting
 +
* cnf
 +
* fileupload
 +
* gef
 +
* nebula-grid
 +
* osgi-packaging
 +
* pde
 +
* tabbed-properties
 +
* visualization
 +
 +
and make them available from [http://build.eclipse.org/rt/rap/incubator/nightly/ build.eclipse.org/rt/rap/incubator/nightly] and from [http://download.eclipse.org/rt/rap/incubator/nightly/ download.eclipse.org/rt/rap/incubator/nightly].

Revision as of 14:50, 20 February 2013

Since version 1.5, RAP is built on the public build server at Eclipse.

Contents

Hudson Builds

Build jobs at the Eclipse.org Hudson:

RAP 1.5 RAP 2.0 RAP 2.x (head)
rap-1.5-runtime rap-2.0-runtime rap-head-runtime
rap-1.5-tools rap-2.0-tools rap-head-tools
rap-1.5-incubator rap-head-incubator-COMPONENT_NAME

The base directory for our builds is /shared/rt/rap on build.eclipse.org.

Nightly Builds

We produce p2 repositories from our nightly builds:

These p2 repositories are updated by a cron job:

/shared/rt/rap/scripts/publish-nightly-build.sh

This job is run by rsternber's crontab.

Procedure for Milestone builds

  • Prepare new base platform in /shared/rt/rap/base-platforms (see HOWTO file)
  • Configure pom.xml files to include the new base platform
    • releng/org.eclipse.rap.build/pom.xml (RAP Runtime)
    • releng/org.eclipse.rap.target.build/pom.xml (RAP Runtime)
    • releng/org.eclipse.rap.tools.build/pom.xml (RAP Tools)
  • Build RAP Runtime and RAP Tools with BUILD_TYPE = S for stable builds (these will be signed)
  • Move repositories to download area (see /shared/rt/rap/publish/)
  • Contribute repositories to simrel aggregator
  • Add tag to git repositories
    • TAG=1.5.0-Mx-YYYYMMDD
    • git tag -a -m "$TAG" -s $TAG (note: -s creates a signed tag)
    • git push --tags origin

Publishing

  • Finalize New & Noteworthy
  • Update web site: builds.xml and arrivals sidebar
  • Scan Bugzilla for open bugs that are targeted at the milestone or bugs that are still open but solved, verify target version of closed bugs
  • Update composite repositories for runtime and tools
  • Update rap/targets/ files
  • [1.5 only] Update rap/latest-stable/{runtime/tooling} repositories to redirect to new repo (for compatibility with 1.4 tooling)
  • Notify the newsgroup
  • Announce via Blog
  • Re-deploy demo applications (in oder to demonstrate the new features from the milestone)

Procedure for release builds

additional steps to do when creating release builds

  • ensure version numbers in bundle manifests
  • ensure legal files (see [1])
    • check that about.html are included in source build
  • update infocenter content and links to infocenter from project home page
  • update help plugin
  • Check copyright year and version number of JavaDoc (search for "JavaDoc" in org.eclipse.rap.releng/tooling/customTargets.xml)
  • Move old builds to archive (dev.eclipse.org:/home/data/httpd/archive.eclipse.org/rt/rap/downloads), update archive page
  • Update the RAP-tooling entry in the Eclipse Marketplace and in the Yoxos Marketplace. They should point to the latest release.
  • Redirect rap/latest-release/{runtime/tooling} repositories
  • notify newsgroup and mailing list
  • use the portal to review project metadata that is displayed in the "About this Project" page (i.e. update release train name in description text)
  • Add p2.stats to artifact.xml
  • Add p2 mirror URLs to artifact.xml
  • Check notice.html and epl-v10.html files for updates
  • Make sure notice.html and epl-v10.html files are included in the download zip files (see bug 347659)

Eclipse Marketplace

Make sure the RAP Tools are uploaded to the Eclipse market place.

Simultaneous Release

RAP Incubator Builds

In order to help early adopters consuming the work from the RAP Incubator project, we are running a set of automated builds from Git HEAD for all RAP Incubator Projects. Every component has its own build that must follow some common naming conventions.

  • Every RAP Incubator Component has a COMPONENT_NAME, that is used to find the necessary build scripts, features, etc.
  • Every component has its own Git repository org.eclipse.rap.incubator.COMPONENT_NAME.git at git.eclipse.org/c/rap/incubator/.
  • The build is based on Tycho and uses the RAP Incubator parent releng/org.eclipse.rap.incubator.releng/pom.xml.
  • The main build project releng/org.eclipse.rap.COMPONENT_NAME.build of the component contains the pom.xml that is used to build the entire component. In addition to that, it has
    • a repository/ sub-directory with an additional pom that creates the final p2 repository of the component.
  • There is a main feature features/org.eclipse.rap.COMPONENT_NAME.feature that assembles everything that is used by a potential consumer.

Every build creates an independent p2 repository. All repositories are available on the build server at

/shared/rt/rap/incubator/nightly/COMPONENT_NAME

At the moment, we are running builds for the following components

  • clientscripting
  • cnf
  • fileupload
  • gef
  • nebula-grid
  • osgi-packaging
  • pde
  • tabbed-properties
  • visualization

and make them available from build.eclipse.org/rt/rap/incubator/nightly and from download.eclipse.org/rt/rap/incubator/nightly.