SCXML 0

Release Plan For Commons SCXML 0.5

Overall Status

The release plan has been executed. Commons SCXML 0.5 was released on July 28, 2006.

This wiki page is now obsolete, please post to commons-dev if you have any comments instead of editing this page.

Release Manager

The release manager is Rahul Akolkar.

Background

Commons SCXML is an implementation of the State Chart XML specification aimed at creating and maintaining a Java SCXML engine. It is capable of executing a state machine defined using a SCXML document, and abstracts out the environment interfaces. The Commons SCXML codebase has now reached a level of stability to justify an initial release in the near future.

This will be the first release of Commons SCXML.

Pre Release Tasks (DONE)

Source

The initial codebase has gone through a number of refactorings, ranging from trivial (renaming variables to be more descriptive) to substantial (breaking up the single env package into separate packages for each environment).
The upto date Commons SCXML revision history is available at: http://jakarta.apache.org/commons/sandbox/scxml/changes-report.html
The code has been run through the Checkstyle, Findbugs gamut.

Web Site

Commons SCXML website has been published and available for about a year: http://jakarta.apache.org/commons/sandbox/scxml/
It continues to be updated frequently (roughly, twice a week).

Documentation

Javadocs are available and are complete: http://jakarta.apache.org/commons/sandbox/scxml/apidocs/index.html
API docs are available: http://jakarta.apache.org/commons/sandbox/scxml/api-notes.html
Usecase examples are available: http://jakarta.apache.org/commons/sandbox/scxml/usecases.html
A wiki has been created: http://wiki.apache.org/jakarta-commons/SCXML

General

Bug Review and Fixes

During the project's infancy, SCXML bugs and enhancements got picked up based on discussions on the mailing lists. This practice was soon discontinued (reports should be filed via Bugzilla), but for a better perspective, here are the issues that were picked up from discussions on the Commons mailing lists:

Issue Description	Severity	Reporter	Status
SCXML send element body content is not parsed	nor	Mike Sparr
Alignment of time model of execution with spec	nor	James Barnett
Digester instances not available for further customization	enh	Mike Sparr
API docs on website need to be improved*	enh	Rahul Akolkar

*Documentation improvements are now also reflected in Bugzilla as following issues:

Issue	Description	Severity	Reporter	Status
38274	Add stop-watch use case	nor	Tim O'Brien
38275	Improve SCXML Digester docs	nor	Tim O'Brien
38276	Improve SCXML Engine docs	nor	Tim O'Brien

In addition, the following issues are on file:

Issue	Description	Severity	Reporter	Status
38311	Decouple object model from execution	nor	Tim O'Brien
38459	JUnit tests	nor	Peter Costa

Check Compatibility

Being the first release of Commons SCXML, there are no backward compatibility concerns.

Release Tasks (DONE)

Sandbox Graduation (DONE)

This release plan will be posted to the commons-dev mailing list.
A reasonable amount of review time (about two weeks) will be allowed for feedback from Commons developers.
A sandbox graduation VOTE will be called after the review time has elapsed.

Sandbox Graduation VOTE (DONE)

VOTE has passed.

SVN (DONE)

This release will take place against TRUNK.

Release Notes (DONE)

These will be prepared in the traditional fashion.

Release Candidates (DONE)

The first release candidate will be prepared shortly after graduating to Commons Proper.
A reasonable amount of time (a week or two) will be allowed for review and testing.
If no issues are reported during the review time, a release VOTE will be called.

Release Commons SCXML 0.5 VOTE (DONE)