You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by mb...@apache.org on 2008/01/02 11:58:26 UTC
svn commit: r608077 -
/incubator/uima/site/trunk/uima-website/xdocs/release.xml
Author: mbaessler
Date: Wed Jan 2 02:58:25 2008
New Revision: 608077
URL: http://svn.apache.org/viewvc?rev=608077&view=rev
Log:
UIMA-684
How to do a release - added first draft
https://issues.apache.org/jira/browse/UIMA-684
Added:
incubator/uima/site/trunk/uima-website/xdocs/release.xml
Added: incubator/uima/site/trunk/uima-website/xdocs/release.xml
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/release.xml?rev=608077&view=auto
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/release.xml (added)
+++ incubator/uima/site/trunk/uima-website/xdocs/release.xml Wed Jan 2 02:58:25 2008
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<document>
+
+<properties>
+<title>Doing a UIMA Release</title>
+<author email="uima-dev@incubator.apache.org">UIMA Documentation Team</author>
+</properties>
+
+<body>
+
+<section name="Doing a UIMA Release">
+
+<p>
+ <ul>
+ <li><a href="#Release Discussions - Release Plan">Release Discussions - Release Plan</a></li>
+ <li><a href="#Preparing The Sourcecode For The Release">Preparing The Sourcecode For The Release</a></li>
+ <li><a href="#Building The Release Candidate">Building The Release Candidate</a></li>
+ </ul>
+</p>
+
+<br></br>
+
+ <subsection name='Release Discussions - Release Plan'>
+ <p>
+ At the beginning of the "UIMA Release Process" there must be consensus in the developer community
+ about the JIRA issues that should be part of the next release and the time frame for the release.
+ The result of this discussion should be published in a release plan to the UIMA wiki.
+ This release plan should be kept up-to-date any time so that everybody can have a look at the target dates
+ to calculate personal ToDos.
+ </p>
+ <p>
+ The previous UIMA release plans and a release plan template is available in the UIMA wiki at
+ <a href="http://cwiki.apache.org/UIMA/release-plan.html">http://cwiki.apache.org/UIMA/release-plan.html</a>
+ </p>
+ </subsection>
+
+ <subsection name='Preparing The Sourcecode For The Release'>
+ <p>
+ Before the source code can be tagged for the release check the points mentioned below:
+ </p>
+ <p>
+ <ul>
+ <li>
+ Make sure that each release artifact that should be released has the correct release version number.
+ </li>
+ <li>
+ Make sure that the README files has been updated with the latest release information and release numbers.
+ </li>
+ <li>
+ Update both versions (text and HTML) of the release notes for the release. JIRA can provide a list of
+ issues for a certain release when using the 'ReleaseNotes' function.
+ </li>
+ <li>
+ Do a quick release audit if for example all license headers are in place by using the
+ <a href="http://code.google.com/p/arat/">RAT</a> (Release Audit Tool) tool.
+ </li>
+ </ul>
+ </p>
+ </subsection>
+
+ <subsection name='Building The Release Candidate'>
+ <p>
+ All the preparation to build the release candidate is done. In the next step we have to tag
+ the release source code in SVN. Most of the time the first release tag isn't the release candidate that is
+ shipped later so we established a simple tag structure where all tags for a release are stored
+ until the final release candidate is found. When looking at the SVN you will find a structure like
+ <br></br><br></br>
+ <code>uimaj/tags/uimaj-<release version>/uima-<release version>-<tag counter>.</code><br></br>
+ <code>uimaj/tags/uimaj-2.2.1/uima-2.2.1-01.</code>
+ <br></br>
+ </p>
+ <p>
+ After tagging the release the release candidate can be build using the provided build scripts.
+ Further details about how to create the release distribution and how to sign them can be found
+ <a href="distribution.html">here</a>.
+ </p>
+ </subsection>
+
+ <subsection name='Creating a Release RAT report'>
+ </subsection>
+
+ <subsection name='Doing The Release Vote'>
+ </subsection>
+
+ <subsection name='Ask Incubator PMC To Release'>
+ </subsection>
+
+ <subsection name='Publish The Release'>
+ - After the vote passes, what to do, including: base release, docs
+ update, archiving older ones, where the release "goes", what to do with
+ the Eclipse update site, etc.
+ - Update the website with the release information.
+ - Upload the artifacts to the Maven repository
+ </subsection>
+
+</section>
+
+</body>
+</document>