Create web page with instructions for creating a release

• Key: JDO-365
• Type: Task
• Status: Resolved
• Resolution: Fixed
• Priority: Major
• Assignee: Craig Russell
• Reporter: Michelle Caisse
• Component/s: site and infrastructure
• Fix Version/s: JDO 2 maintenance release 1

Description

Make information about how to do a release available to the community so that release manager responsibility can be shared.

Comments

[Craig Russell]

Please review these files. The intent is to publish them in the top level directory (at the same level as branches, trunk, site).

The information could instead be published on the JDO web site, but it's not clear that the public needs to know this information.

[Michelle Caisse]

I have made comments on HowToReleaseJDO.txt in-line in the attachment.

[Craig Russell]

Please review this document. I've updated it to include the latest tck20.dist target that automatically copies release artifacts to the releases directory in svn.

[Craig Russell]

Please review this document. I think it's just about ready for checkin.

I propose to put this file parallel to trunk and branches.

[Michelle Caisse]

I've attached a new version with some minor changes and a rewrite of step 12. Also, should we add some text on our version numbering policy?

[Craig Russell]

I've added some text to describe the release numbering scheme. Comments?

The release manager first decides on the name of the release. The format
of the name is <spec-number>.<major>.<minor>.<update>.
The spec-number is either 1 for JDO 1 or 2 for JDO 2. The major number might change for
a new JSR. The minor number would change for a specification revision
approved by the JCP via specification maintenance review. The update number
can be used for changes that do not need a maintenance review and do
not change the interfaces.

Interim releases prior to final release are identified by a suffix on the
release number. Common suffixes include: -alpha, -beta, -beta2, -rc1, -rc2.
Generally, the suffixes are part of the release plan, and the contents
of each suffix release are agreed by the community. There might be
significant changes in functionality between the suffix releases. Each
suffix release goes through the process documented here.

[Michelle Caisse]

What is the rule for trailing zeroes in the release number? Currently we have 2.0, not 2 or 2.0.0.0.

[Craig Russell]

Here's a proposal for eliding the trailing minor and update releases.

The community first decides on the name of the release. The format
of the name is <spec-number>.<major>.<minor>.<update>. Trailing <update>
and <minor> numbers are elided. The spec-number
is either 1 for JDO 1 or 2 for JDO 2. The major number might change for
a new JSR. The minor number would change for a specification revision
approved by the JCP via specification maintenance review. The update number
can be used for changes that do not need a maintenance review and do
not change the interfaces.

[Craig Russell]

Oops, try this:

The community first decides on the name of the release. The format
of the name is <spec-number>.<major>.<minor>.<update>. The spec-number
is either 1 for JDO 1 or 2 for JDO 2. The major number might change for
a new JSR. The minor number would change for a specification revision
approved by the JCP via specification maintenance review. The update number
can be used for changes that do not need a maintenance review and do not change the interfaces. Trailing <update> and <minor> numbers with zero values are right trimmed, so there might be a 2.0.0.1 or a 2.0.1but not a 2.0.0 or 2.0.1.0.

[Craig Russell]

svn commit -m "JDO-365 create instructions for releasing JDO" HowToReleaseJDO.txt
Adding HowToReleaseJDO.txt
Transmitting file data .
Committed revision 411941.