Difference between revisions of "Higgins Component Owner Checklist"

Revision as of 10:00, 30 January 2007

A. Components

The component owner is responsible for maintaining all information about their rows related to their component on this page Components. There are two kinds of Components:

• Single project components --one have one top level row describing the one project
  • Multi-project components --have a top level row and multiple sub-rows, one for each project
• The leftmost column should link to a wiki page that contains at least:
  • Overview - a one para overview of the function of the component (or-project, if project-level row) as well as these sub-sections:
    • Status: <status of Component>
    • Language: <Java, Javascript, etc.>
    • Web sub-component
      • Packaging: <WAR, etc.>
      • Technology Dependencies: <e.g. JSP/Servlets, JSTL, JSF, AJAX, JavaMail, JAXB >
      • JAR File Dependencies: <e.g. Apache Jakarta Commons, Spring Framework
    • Core sub-component
      • Packaging: <e.g. JAR>
      • Dependencies: <e.g. EJB, Web Services, Apache Jakarta Commons>
      • Deployment: <e.g. WAR module on remote Java EE app server or OSGI server>
  • Service - a description of some of the most salient methods of the interface
• Dep.
  • The owner MUST create and maintain the "dep" dependencies page. Any new additions must be flagged to mary@socialphysics.org so that she can enter the new third party JARs into IPzilla.
• Source & Build
  • viewcvs - create a link to web view of component's cvs folders
  • ide - create and maintain a wiki page describing how to get the source and build the component using the Eclipse IDE. It MUST include at least two .psf files (one for anonymous access, one for committers) and these two MUST include all of the component's projects and any projects that are just wrappers around third party libs. It should NOT include projects from other Higgins components.
  • cli - create and maintain a wiki page describing how to get the source and bulid the JAR(s) of this component using a command line (i.e. cvs client and Ant)
• Test
  • Component owners are responsible for ensuring that the sub-projects that comprise their component(s) also have associated "sister" -test projects.
• Downloads and/or Service URL
  • javadoc - create a link to the javadoc files mostly recently generated nightly on build.eclipse.org
  • plugins - create a link to one or more Eclipse plugins most recently built on build.eclipse.org
  • jars - create a link to one or more JARS most recently built on build.eclipse.org
• Open
  • Owner MUST add Bugzilla entries for the most important new features (or bugs) being worked on for the current milestone
  • Owner SHOULD add the most important ones to the current milestone wiki page

See Also

• Components
• Higgins Home

B. Build Processes

• Component owner must use Eclipse 3.2.x 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

C. Components (and their sub-Projects if any) 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 Version Numbering for details)
  • test JARs include -test before .major.minor.service.qualifier
  • example: "higgins-idas-test.0.7.103.jar"

D. Stable Builds

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

See Also

• Higgins Home