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.
Difference between revisions of "Higgins Component Owner Checklist"
| Line 17: | Line 17: | ||
**Owner MUST add Bugzilla entries for the most important new features (or bugs) being worked on for the current milestone | **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 | **Owner SHOULD add the most important ones to the current milestone wiki page | ||
| + | |||
| + | ===build.xml=== | ||
| + | *Owner must use Eclipse 3.2.x to define projects for the component | ||
| + | **Owner manage the project from within Eclipse 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 target | ||
| + | *Owner must make sure that automated build scripts are using the latest build.xml | ||
| + | *JAR (and WAR, etc.) files should be named "higgins-<component>-<subcomponent>.x.Y.Z.jar | ||
| + | *X.Y is the current milestone (e.g. 0.7) | ||
| + | *Z starts at zero and is incremented only for breaking changes | ||
| + | *test JARs include -test before X.Y.Z | ||
| + | *example: "higgins-idas-test.0.7.3.jar" | ||
Revision as of 14:51, 24 January 2007
Component Row
The component owner is responsible for maintaining all information about their rows here Components.
- The leftmost column should link to a wiki page that contains at least:
- Overview - a one para overview of the function of the component
- Service - a description of some of the most salient methods of the interface
- Libs
- The owner MUST create and maintain the "libs" 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)
- Download
- 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
build.xml
- Owner must use Eclipse 3.2.x to define projects for the component
- Owner manage the project from within Eclipse 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 target
- Owner must make sure that automated build scripts are using the latest build.xml
- JAR (and WAR, etc.) files should be named "higgins-<component>-<subcomponent>.x.Y.Z.jar
- X.Y is the current milestone (e.g. 0.7)
- Z starts at zero and is incremented only for breaking changes
- test JARs include -test before X.Y.Z
- example: "higgins-idas-test.0.7.3.jar"