[jboss-cvs] JBossAS SVN: r107764 - in projects/jboss-jca/trunk/doc/developerguide/en: modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue Aug 24 12:03:05 EDT 2010
Author: jesper.pedersen
Date: 2010-08-24 12:03:05 -0400 (Tue, 24 Aug 2010)
New Revision: 107764
Added:
projects/jboss-jca/trunk/doc/developerguide/en/modules/releases.xml
Modified:
projects/jboss-jca/trunk/doc/developerguide/en/master.xml
Log:
Describe Releases; their versions and identifiers
Modified: projects/jboss-jca/trunk/doc/developerguide/en/master.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/master.xml 2010-08-24 15:19:53 UTC (rev 107763)
+++ projects/jboss-jca/trunk/doc/developerguide/en/master.xml 2010-08-24 16:03:05 UTC (rev 107764)
@@ -5,6 +5,7 @@
<!ENTITY preface SYSTEM "../../userguide/en/modules/preface.xml">
<!ENTITY introduction SYSTEM "../../userguide/en/modules/introduction.xml">
<!ENTITY building SYSTEM "modules/building.xml">
+ <!ENTITY releases SYSTEM "modules/releases.xml">
<!ENTITY issuetracking SYSTEM "modules/issuetracking.xml">
<!ENTITY testing SYSTEM "modules/testing.xml">
<!ENTITY metadata SYSTEM "modules/metadata.xml">
@@ -35,6 +36,8 @@
&building;
+ &releases;
+
&issuetracking;
&testing;
Added: projects/jboss-jca/trunk/doc/developerguide/en/modules/releases.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/releases.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/releases.xml 2010-08-24 16:03:05 UTC (rev 107764)
@@ -0,0 +1,174 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="releases">
+ <title>Releases</title>
+
+ <para>The chapter describes the various releases and their exit criteria.</para>
+
+ <section id="releases_overview">
+ <title>Overview</title>
+
+ <para>Each release is labelled with a version number and an identifier.</para>
+
+ <programlisting>
+ironjacamar-<major>.<minor>.<patch>[.<identifier>]
+ </programlisting>
+
+ <para>where</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ Major: The major version number. Signifies major changes in the implementation.
+ </listitem>
+ <listitem>
+ Minor: The minor version number. Signifies functional changes to a major version.
+ </listitem>
+ <listitem>
+ Patch: The patch version number. Signifies a binary compatible change to a minor version.
+ </listitem>
+ <listitem>
+ Identifier: The identifier. Identifies the level of the quality of the release.
+ <itemizedlist spacing="compact">
+ <listitem>
+ None / Final: Stable release
+ </listitem>
+ <listitem>
+ CR: Candidate for Release quality. The implementation is functional complete.
+ </listitem>
+ <listitem>
+ Beta: Beta quality. The implementation is almost functional complete.
+ </listitem>
+ <listitem>
+ Alpha: Alpha quality. The implementation is a snapshot of the development.
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+
+ <section id="releases_versioning">
+ <title>Versioning</title>
+
+ <para>Each release will contain a version number which relates to the
+ feature branch where it was created.</para>
+
+ <!-- TODO: Add a picture with versions for various branches -->
+
+ <section id="releases_versioning_major">
+ <title>Major</title>
+
+ <para>A Major version identifier signifies major changes in the implementation such as
+ a change in the architecture.</para>
+
+ <para>The features between major versions can be a lot different, and therefore feature
+ regressions may appear.</para>
+
+ <para>A Major version will most likely also mean updates to the configuration and required
+ metadata files for deployments.</para>
+
+ </section>
+
+ <section id="releases_versioning_minor">
+ <title>Minor</title>
+
+ <para>A Minor version identifier signifies functional changes to a Major release.</para>
+
+ <para>This means that new features have been added to the Major release, and hence may have
+ new configuration options and integration points.</para>
+
+ <para>The release is binary compatible to the previous releases -
+ for example <code>1.0</code> vs. <code>1.1</code>.</para>
+
+ </section>
+
+ <section id="releases_versioning_patch">
+ <title>Patch</title>
+
+ <para>A Patch version identifier signifies a binary compatible update to one or more components in a Minor release.</para>
+
+ <para>This means that one or more bug fixes to existing components have been integrated in the branch in question.</para>
+
+ <para>The release is binary compatible to the previous releases -
+ for example <code>1.0.0</code> vs. <code>1.0.1</code>.</para>
+
+ </section>
+
+ </section>
+
+ <section id="releases_identifiers">
+ <title>Identifiers</title>
+
+ <para>Each release will contain an identifier which relates to the release quality.</para>
+
+ <!-- TODO: Add a picture with identifiers for various branches -->
+
+ <section id="releases_alpha">
+ <title>Alpha releases</title>
+
+ <para>An Alpha release is a snapshot of the main development branch which likely will
+ contain new features.</para>
+
+ <warning>
+ Alpha releases are NOT production quality
+ </warning>
+
+
+ <para>An Alpha release are made each month (time-boxed) unless the branch is using an identifier as
+ Beta or higher.</para>
+
+ <para>The exit criteria for an Alpha release is that the main test suite is passing.</para>
+
+ </section>
+
+ <section id="releases_beta">
+ <title>Beta releases</title>
+
+ <para>A Beta release contains major features that are considered almost functional complete.
+ This doesn't mean however that all aspects of each feature is complete and therefore
+ not all options will be active.</para>
+
+ <warning>
+ Beta releases are NOT production quality
+ </warning>
+
+ <para>A Beta release will be made once one or more features are almost functional complete and
+ therefore Beta releases aren't time-boxed, but feature-boxed instead.</para>
+
+ <para>The exit criteria for a Beta release is that all test suites are passing.</para>
+
+ </section>
+
+ <section id="releases_cr">
+ <title>Candidate for Release releases</title>
+
+ <para>A Candidate for Release is considered functional complete and candidate for being
+ promoted to a Final release.</para>
+
+ <warning>
+ Candidate for Release releases are NOT production quality
+ </warning>
+
+ <para>A Candidate for Release focuses on functionality, but they are time-boxed to a maximum
+ of two weeks between each release.</para>
+
+ <para>The exit criteria for a Candidate for Release release is that all test suites are passing.</para>
+
+ </section>
+
+ <section id="releases_final">
+ <title>Final releases</title>
+
+ <para>A Final release is considered feature complete and stable.</para>
+
+ <para>Typically only one Final release will be released from each branch, unless critical or blocker issues
+ are found in the release. Patch releases will be available from our source control system as
+ tags.</para>
+
+ <para>The exit criteria for a Final release is that all test suites are passing.</para>
+
+ </section>
+
+ </section>
+
+
+</chapter>
More information about the jboss-cvs-commits
mailing list