Menu
▾
▴
[Mockobjects-java-dev] CVS: mockobjects-java/doc/xdocs release_process.xml,NONE,1.1 doc-book.xml,1.7,1.8 site-book.xml,1.7,1.8
|
From: Vincent M. <vm...@us...> - 2001-08-21 11:41:30
|
Update of /cvsroot/mockobjects/mockobjects-java/doc/xdocs
In directory usw-pr-cvs1:/tmp/cvs-serv30473
Modified Files:
doc-book.xml site-book.xml
Added Files:
release_process.xml
Log Message:
new release process page that explains our release process
--- NEW FILE: release_process.xml ---
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
<document>
<header>
<title>Release Process</title>
<authors>
<person name="Vincent Massol" email="vm...@us..."/>
</authors>
</header>
<body>
<s1 title="Introduction">
<p>
This document highlights our release process. It defines all the
steps that need to be performed <strong>before</strong> releasing a new
version of the Mock Objects project.
</p>
</s1>
<s1 title="General steps">
<s2 title="Decide on the content of a release">
<p>
Long before any release, we need to define what will go into that
release, i.e. the list of tasks that need to be performed
<strong>prior</strong> to that release. These tasks will be listed on
the <link href="todo.html">Todo page</link>. Tasks can be proposed on
the <link href="http://sourceforge.net/mail/?group_id=18189">mailing
list</link>.
</p>
</s2>
<s2 title="Deciding on doing a release">
<p>
Releasing a version is a community action that we all need to decide
together (the committers of the project). Before <strong>any</strong>
release, we will need to agree on doing a release. This entails sending
a message on the
<link href="http://sourceforge.net/mail/?group_id=18189">mailing
list</link> asking for a vote on the release. We will use the
<link href="http://jakarta.apache.org/site/decisions.html">Apache
Jakarta system for voting</link>.
</p>
</s2>
<s2 title="Updating the Changes page">
<p>
The <link href="changes.html">Changes page</link> need to be up to date
at any time. The goal of this page is not to described fine-grained
changes in CVS like "I have corrected a typo" but rather to advertise
changes that are useful to end users (for example: "Improved the
Mailing-list example by ..."). As it is very hard to
remember everything that everyone has done, it is mandatory to fill this
page as we do the modifications and not to wait till the release to fill
it.
</p>
</s2>
</s1>
<s1 title="Detailed administrative steps">
<p>
This is a detailed check list of all the steps involved to actually
perform the release :
</p>
<ol>
<li>
Agree on a release (see above).
</li>
<li>
Designate a release manager for the current release.
</li>
<li>
Ensure that no one is working on any part of the files (code freeze).
This is done by posting a mail on the list asking for a code freeze.
</li>
<li>
Verify that the <link href="todo.html">todo.xml</link> page is up to
date.
</li>
<li>
Verify that the <link href="changes.html">changes.xml</link> page is up
to date.
</li>
<li>
Verify that the <link href="features.html">features.xml</link> page is
up to date and includes all features available in all releases + the
new ones from this release.
</li>
<li>
Verify that the news items on the
<link href="index.html">index.html</link> page are up to date (major
announcement should be listed there, a release is a major announcement
- A news item should be added that says which version has been released
with a link pointing to the changes page).
</li>
<li>
Perform a Ant build on the dist target (<code>ant dist</code>) on the
release manager's machine to ensure everything build fine including the
tests, web site generation, ...
</li>
<li>
Tag CVS, with the name MO_<version number>_RELEASE (For example,
the 0.01 release would be tagged MO_0_01_RELEASE).
</li>
<li>
Publish the distributables files to
<link href="https://sourceforge.net/project/admin/editpackages.php?group_id=18189">
SourceForge</link>. In the release notes area of SF, put a link to the
Changes page (http://mockobjects.sf.net/changes.html).
</li>
<li>
Increase the version number indicated in the <code>build.xml</code>
file by 1 (for example, after 0.01, put 0.02).
</li>
<li>
Write a short release announcement in the news area of SourceForge
(with a link to the Changes page).
</li>
<li>
Send a message to the dev and user mailing-lists of Mock Objects to
announce the availability of the release (and add a link to the
Changes page).
</li>
<li>
Send announcements to other mailing-lists (XP mailing lists
on yahoogroups, JUnit mailing list) and web sites (junit.org,
objectmentor, ...)
</li>
<li>
... then relax ! ;-)
</li>
</ol>
</s1>
</body>
</document>
Index: doc-book.xml
===================================================================
RCS file: /cvsroot/mockobjects/mockobjects-java/doc/xdocs/doc-book.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- doc-book.xml 2001/08/21 10:44:06 1.7
+++ doc-book.xml 2001/08/21 11:41:27 1.8
@@ -33,6 +33,7 @@
<menu-item type="external" label="CVS"
href="http://sourceforge.net/cvs/?group_id=18189"/>
<menu-item label="Coding conventions" source="coding_conventions.xml"/>
+ <menu-item label="Release process" source="release_process.xml"/>
</menu>
</book>
Index: site-book.xml
===================================================================
RCS file: /cvsroot/mockobjects/mockobjects-java/doc/xdocs/site-book.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- site-book.xml 2001/08/21 10:44:06 1.7
+++ site-book.xml 2001/08/21 11:41:27 1.8
@@ -33,6 +33,7 @@
<menu-item type="external" label="CVS"
href="http://sourceforge.net/cvs/?group_id=18189"/>
<menu-item label="Coding conventions" source="coding_conventions.xml"/>
+ <menu-item label="Release process" source="release_process.xml"/>
</menu>
</book>
|
