forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ferdin...@apache.org
Subject svn commit: r408000 - in /forrest/trunk/site-author/content/xdocs: ./ procedures/ procedures/release/
Date Sat, 20 May 2006 13:55:20 GMT
Author: ferdinand
Date: Sat May 20 06:55:19 2006
New Revision: 408000

URL: http://svn.apache.org/viewvc?rev=408000&view=rev
Log:
Start of re-writing release.txt as part of forrest docs

Added:
    forrest/trunk/site-author/content/xdocs/procedures/
    forrest/trunk/site-author/content/xdocs/procedures/release/
    forrest/trunk/site-author/content/xdocs/procedures/release/How_to_release.xml
    forrest/trunk/site-author/content/xdocs/procedures/release/anounce_code_freeze.txt
    forrest/trunk/site-author/content/xdocs/procedures/release/propose_release_plan.txt
    forrest/trunk/site-author/content/xdocs/procedures/release/test_and_vote_on_rel_cand.txt
Modified:
    forrest/trunk/site-author/content/xdocs/roles.xml
    forrest/trunk/site-author/content/xdocs/site.xml

Added: forrest/trunk/site-author/content/xdocs/procedures/release/How_to_release.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/procedures/release/How_to_release.xml?rev=408000&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/procedures/release/How_to_release.xml (added)
+++ forrest/trunk/site-author/content/xdocs/procedures/release/How_to_release.xml Sat May
20 06:55:19 2006
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2006 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed 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.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+  "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+    <header>
+        <title>How to Release Forrest</title>
+        <abstract>This documents the steps that the Release Manager (RM) should follow
when doing a Forrest
+        release.</abstract>
+    </header>
+    <body>
+
+        <section id="About">
+            <title>About this Document</title>
+            <p>This documents the steps that the Release Manager (RM) should follow
when doing a Forrest release. Note
+                that it might have mistakes - we seem to discover something new each time
and some steps might need to
+                happen in a different order. Fine tune these notes for next time. Do some
practice runs.</p>
+
+            <p>There are some steps that other committers, and even developers, can
assist with, especially in the areas
+                of getting ready for the release and the final testing. Many of the steps
can be done only by the
+                Release Manager.</p>
+
+            <p>It is not the Release Manager's job to fix bugs nor address blocker
issues. The RM job begins when the
+                project is ready to do the release.</p>
+
+            <p>Review the "FIXME" notes below.</p>
+        </section>
+        <section id="Preparations">
+            <title>Preparations</title>
+            
+            <ol>
+                <li>
+                    <p>The Release Manager (RM) starts the process to finalise the
outstanding blocker issues. </p>
+                    <p>Check and make sure the following preconditions are met:</p>
+                    <ul>
+                        <li>
+                            <p>Has the project prepared or updated the Roadmap to schedule
the realistic Issues?</p>
+                        </li>
+                        <li>
+                            <p>Has the project made good progress towards fixing the
Blockers and applying the
+                                outstanding patches?</p>
+                        </li>
+                    </ul>
+                    <p>If so send an email to get the project to decide what to do
with the remaining issues. Propose to
+                        delay some issues to a future release, encourage people to fix others.
See <a
+                            href="http://issues.apache.org/jira/browse/FOR-853"
+                            >FOR-853</a>. Look at <a
+                                href="http://www.mail-archive.com/dev@forrest.apache.org/msg02310.html">msg02310.html</a>
+                        for an example of such a message.</p>
+                    
+                    <fixme>What if preconditions are not met?</fixme>
+                </li>
+                <li>
+                    <p>Prepare the Release Plan to define the corner stones of the
coming release</p>
+                    
+                    <ul>
+                        <li>Start of code-freeze</li>
+                        <li>Start of test-period</li>
+                        <li>Vote on release candidate</li>
+                        <li>Optional creation of release candidate #2 (when there are
bugs)</li>
+                        <li>Start of test-period #2</li>
+                        <li>Vote on release candidate #2</li>
+                        <li>Scheduled release Date</li>
+                    </ul>
+                    <p>Use email template <a href="propose_release_plan.txt">propose_release_plan.txt</a>
to plan and
+                        propose.</p>
+                    
+                    
+                </li>
+                <li>
+                    <p>Call for a quick vote on the release plan on the dev list.</p>
+                    <note><p>There are various reasons for voting on the Release
Plan, e.g. makes people aware that a
+                        code-freeze is about to happen; encourage them to get involved with
the release; ensure that the
+                        date is suitable and people will be around to test and then vote
on the actual release. See a
+                        good discussion <a href="http://marc.theaimsgroup.com/?t=114296877800003">in
the archives</a> </p></note>
+                </li>
+            </ol>
+        </section>
+
+    </body>
+</document>

Added: forrest/trunk/site-author/content/xdocs/procedures/release/anounce_code_freeze.txt
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/procedures/release/anounce_code_freeze.txt?rev=408000&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/procedures/release/anounce_code_freeze.txt (added)
+++ forrest/trunk/site-author/content/xdocs/procedures/release/anounce_code_freeze.txt Sat
May 20 06:55:19 2006
@@ -0,0 +1,35 @@
+Subject: [Important] code-freeze commenced
+
+The code-freeze is now happening to allow us to pack the
+release candidates and make them available for testing.
+
+Code-freeze means *no* non-essential commits to the trunk
+or to the new release branch. Other branches are free to
+continue.
+
+There should be no code enhancements or new functionality,
+because that could introduce new bugs.
+
+The main aim is to find and fix important bugs. Any minor
+issues are delayed until after release (add to Jira).
+
+Documentation corrections can happen because they will not
+break anything. As long as we do test the documentation
+building just prior to making the final release candidate.
+
+However, if there are important code changes that are required
+you can make a proposal to allow that commit. The PMC will
+make a quick decision.
+
+Next important milestones are:
+
+* Create release candidate #2 if there have been changes
+  on Friday 2005-06-17 at 22:00 UTC [2]
+  [2] http://www.timeanddate.com/worldclock/meetingtime.html?day=18&month=06&year=2005&p1=48&p2=176&p3=240&p4=224&p5=213
+
+* Actual release date is Sunday 2005-06-19 at 14:00 UTC [3]
+  [3] http://www.timeanddate.com/worldclock/meetingtime.html?day=20&month=06&year=2005&p1=48&p2=176&p3=240&p4=224&p5=213
+
+Now we will go and build the releases which might take
+some time. The next message will tell you where to get
+the release candidates and describe how to test.
\ No newline at end of file

Added: forrest/trunk/site-author/content/xdocs/procedures/release/propose_release_plan.txt
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/procedures/release/propose_release_plan.txt?rev=408000&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/procedures/release/propose_release_plan.txt (added)
+++ forrest/trunk/site-author/content/xdocs/procedures/release/propose_release_plan.txt Sat
May 20 06:55:19 2006
@@ -0,0 +1,34 @@
+Subject: [VOTE] Release Plan for Forrest x.xx
+
+We are about to work on releasing a new version of Forrest.
+
+Proposed milestones are:
+
+- Start of code-freeze on [Date]
+  [www.timeanddate.com-URL]
+
+- Start of test-period [Date]
+  [www.timeanddate.com-URL]
+
+- Vote on release candidate #1 [Date]
+  [www.timeanddate.com-URL]
+
+- Start of test-period [Date]
+  [www.timeanddate.com-URL]
+
+- Vote on release candidate [Date]
+  [www.timeanddate.com-URL]
+
+- Optional creation of release candidate #2 (when there are bugs) [Date]
+  [www.timeanddate.com-URL]
+
+- Start of test-period #2 [Date]
+  [www.timeanddate.com-URL]
+
+- Vote on release candidate #2 [Date]
+  [www.timeanddate.com-URL]
+
+- Scheduled release Date [Date]
+  [www.timeanddate.com-URL]
+
+Please check with your schedules and comment.
\ No newline at end of file

Added: forrest/trunk/site-author/content/xdocs/procedures/release/test_and_vote_on_rel_cand.txt
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/procedures/release/test_and_vote_on_rel_cand.txt?rev=408000&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/procedures/release/test_and_vote_on_rel_cand.txt
(added)
+++ forrest/trunk/site-author/content/xdocs/procedures/release/test_and_vote_on_rel_cand.txt
Sat May 20 06:55:19 2006
@@ -0,0 +1,56 @@
+Subject: [Important] please test release candidate then vote
+
+We need people to test the release candidate on your projects,
+especially on different operating systems. Just send a short
+reply to this thread that it works for you. See method below.
+
+Download the release candidate and supporting files:
+http://www.apache.org/~crossley/release-forrest-07/
+
+For Windows get *.zip md5sum ################################
+For UNIX get *.tar.gz md5sum ################################
+Get the *.asc and *.md5 that match your chosen download.
+
+It was packed from SVN revision ####
+Java 1.4 or later is required.
+
+If you want to verify the download, then follow:
+http://forrest.apache.org/mirrors.cgi#verify
+
+Otherwise just get on with testing.
+
+Testing and vote period concludes Sunday 2005-06-19 14:00 UTC
+Anyone can test and vote, not just PMC members.
+However only the PMC votes are binding.
+
+So we have approximately 6 days.
+
+Here are some hints:
+
+  * Ensure that the compressed archive will unpack properly.
+  * Verfiy the release, especially if you are a committer.
+  * Follow the README.txt and index.html
+  * Set environment variables.
+  * Don't worry too much about minor bugs. We are looking
+     for blockers, such as it will not run. Many known issues
+     are recorded at our Jira, perhaps you can add more.
+
+* Make a fresh site ...
+    cd my-new-dir
+    forrest seed
+    forrest run ... use the local jetty server.
+    forrest ... build the whole site from the command-line.
+    forrest war ... use your own full Jetty or Tomcat.
+
+* Try it on the Forrest core docs ...
+    cd site-author
+    forrest run
+
+* Forrest was already pre-built. Try building it again.
+    cd main
+    build clean
+    build
+    build test
+
+* Try it on your own project, especially if you have
+    a project sitemap and use some extra plugins.
\ No newline at end of file

Modified: forrest/trunk/site-author/content/xdocs/roles.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/roles.xml?rev=408000&r1=407999&r2=408000&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/roles.xml (original)
+++ forrest/trunk/site-author/content/xdocs/roles.xml Sat May 20 06:55:19 2006
@@ -77,7 +77,7 @@
       <section id="release-manager">
         <title>Release Manager</title>
         <p>Tasks are defined in 
-          <a href="http://svn.apache.org/repos/asf/forrest/trunk/etc/RELEASE_PROCESS.txt">etc/RELEASE_PROCESS.txt</a>
+            <a href="site:howToRelease">How to Release Forrest</a>
         </p>
         <p>Only one person can do this role, although other people can assist.
           There is a lot of knowledge invested in this role. Document it as much

Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/site.xml?rev=408000&r1=407999&r2=408000&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Sat May 20 06:55:19 2006
@@ -84,7 +84,8 @@
             a new howto-document"/>
         <gump-forrest label="Gump Integration" href="gump.html"/>
         <zoneMangement label="Zone notes Testbed-Management" description="Notes for committers
to manage forrest.zones.apache.org" href="zone.html"/>
-        
+        <howToRelease label="How to release" href="procedures/release/How_to_release.html"
description="Instructions on preparing and
+            creating a new Forrest release."/>
     </procedures>
 
   <proposals label="Proposals" tab="project">



Mime
View raw message