Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Higgins Component Owner Checklist"

(Build Processes)
(Structure and Naming)
Line 28: Line 28:
 
*Owner must make sure that automated build scripts are using the latest build.xml
 
*Owner must make sure that automated build scripts are using the latest build.xml
  
== Structure and Naming==
 
*All project names in the component must follow Eclipse guidelines for naming
 
*There should be as few projects in a component as possible. The preference would be to have one core project plus one unit test project. The decision to add additional projects is based on architectural considerations (e.g. the need for separable plugins).
 
*JAR (and WAR, etc.) files should be named "higgins-<component>-<subcomponent>.major.minor.service.qualifier.jar (see [http://wiki.eclipse.org/index.php/Version_Numbering Version Numbering] for details)
 
**test JARs include -test before .major.minor.service.qualifier
 
**example: "higgins-idas-test.0.7.103.jar" - see special instructions below
 
  
====While Higgins is in the Incubation phase ====
 
 
* All downloadable zip files for builds and milestones must include the word "incubation" in the filename. For example, DSF-SDK-incubation-N20070413-0200.zip
 
 
* The jar files in the download zip file are not required to contain the word "incubation" in the filename. (See bug 178944 for the explanation.)
 
 
* All "Bundle-Name"s must include the world "incubation". Note that "Bundle-SymbolicName"s should not include "incubation" because the Bundle-SymbolicName is a technical namespace, not a user namespace. For example, Bundle-Name: Foo Plug-in (Incubation)
 
* Similarly, the names for update manager features must include the word "incubation". For example, Eclipse Platform (Incubation)
 
  
 
== Builds==
 
== Builds==

Revision as of 15:45, 4 January 2008

Component owners are responsible for creating and maintaining the following wiki doc, build scripts, etc. for their Components.

Solution Owners

  1. Solution owner MUST add a link to the solution here Solutions
  2. Solution owner MUST create the solution page using Solution Description Template

Component Owners

  1. Owners MUST create rows (and sometimes entire tables) for each project Components page.
  2. Owners MUST hand create wiki pages in the "Dependencies" column (entitled "Dep.") on the Components page.
  3. Owners MUST edit the autobuild scripts to include components in the nightly build
  4. Owners MUST create a "row" wiki page for each row using the Component Description Template

Build Processes

  • Component owner MUST use Eclipse 3.3 to define Eclipse projects within component
  • Read Eclipse Build Automation
  • The owner must ensure that each project (dependencies, etc.) can be managed from within the Eclipse IDE without manually editing build.xml files
  • It must be possible for each project to export a build.xml Ant file such that
    • It can be used to build all appropriate targets from a command line using CVS and Ant
    • It must not use any absolute class names
    • It must not require eclipse-specific jar files (only stated dependencies)
    • It must build when eclipse is not installed
    • It must be able to build both release and debug targets
    • Targets
      • jar for any consumable component
      • war file for WS deployable components
      • javadoc
      • eclipse plugin
  • Owner must make sure that automated build scripts are using the latest build.xml


Builds

Nightly

Stable

  • The component owner determines when a build should be promoted from "nightly" to "stable"
  • [The higgins project doesn't yet have any "release" builds]

Links

Back to the top