You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@click.apache.org by sa...@apache.org on 2009/01/05 19:26:23 UTC

svn commit: r731643 - in /incubator/click/trunk/click/documentation/docs/developer-guide: developer-guide.html releasing-subprojects.html releasing.html

Author: sabob
Date: Mon Jan  5 10:26:22 2009
New Revision: 731643

URL: http://svn.apache.org/viewvc?rev=731643&view=rev
Log:
added release guide for subprojects

Added:
    incubator/click/trunk/click/documentation/docs/developer-guide/releasing-subprojects.html
Modified:
    incubator/click/trunk/click/documentation/docs/developer-guide/developer-guide.html
    incubator/click/trunk/click/documentation/docs/developer-guide/releasing.html

Modified: incubator/click/trunk/click/documentation/docs/developer-guide/developer-guide.html
URL: http://svn.apache.org/viewvc/incubator/click/trunk/click/documentation/docs/developer-guide/developer-guide.html?rev=731643&r1=731642&r2=731643&view=diff
==============================================================================
--- incubator/click/trunk/click/documentation/docs/developer-guide/developer-guide.html (original)
+++ incubator/click/trunk/click/documentation/docs/developer-guide/developer-guide.html Mon Jan  5 10:26:22 2009
@@ -49,6 +49,9 @@
                 <a href="releasing.html">Creating a Release</a>
             </li>
             <li>
+                <a href="releasing-subprojects.html">Creating a Release for Subprojects</a>
+            </li>
+            <li>
                 <a href="contributing.html">Contributing</a>
             </li>
         </ul>

Added: incubator/click/trunk/click/documentation/docs/developer-guide/releasing-subprojects.html
URL: http://svn.apache.org/viewvc/incubator/click/trunk/click/documentation/docs/developer-guide/releasing-subprojects.html?rev=731643&view=auto
==============================================================================
--- incubator/click/trunk/click/documentation/docs/developer-guide/releasing-subprojects.html (added)
+++ incubator/click/trunk/click/documentation/docs/developer-guide/releasing-subprojects.html Mon Jan  5 10:26:22 2009
@@ -0,0 +1,122 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+"http://www.w3.org/TR/html4/loose.dtd">
+<!--
+   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.
+-->
+<html>
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+        <meta name="Author" content="Malcolm Edgar"/>
+        <meta name="description" lang="en" content="Apache Click Java web application framework"/>
+        <meta name="keywords" lang="en" content="Apache Click, Click Framework, Java, JEE, J2EE, web application framework, open source"/>
+        <title>Apache Click</title>
+        <link rel="stylesheet" type="text/css" href="../../help.css"/>
+        <style type="text/css">
+            th { text-align: left; }
+            td { vertical-align: top; white-space: nowrap; }
+        </style>
+    </head>
+    <body>
+
+        <h1>Creating a Release for Subprojects</h1>
+
+        This page documents the requirements for releasing a Click subproject.
+
+        <p/>
+        <b>Please note</b> this section is for committers only.
+
+        <h3>Prerequisites</h3>
+
+        Subprojects have the same prerequisites as Click. See <a href="releasing.html#prerequisites">here</a> for details.
+
+        <h3>Release Procedure</h3>
+
+        Subproject releases should adhere to the following steps:
+
+        <ol>
+            <li>
+                Create the distribution using your favorite build tool e.g. Ant.
+            </li>
+            <li>
+                Create MD5 and SHA1 hashes of the distribution file.
+            </li>
+            <li>
+                Digitally sign the distribution, for example:
+                <pre class="codeConfig">gpg --armor --output ClickIDE-X.X.X-incubating.zip.asc --detach-sig ClickIDE-X.X.X-incubating.zip</pre>
+            </li>
+            <li>
+                Upload the distribution to your account at <tt>people.apache.org</tt>
+                under the folder <tt>~/public_html/release/X.X.X</tt>, where X.X.X
+                is the version number of the project.
+            </li>
+            <li>
+                Verify the digital signatures at <tt>people.apache.org</tt> to
+                ensure nothing went wrong with the upload.
+                <p/>
+                Please note if this is the first time you verify your key
+                at <tt>people.apache.org</tt>, you'll need to import your public
+                key first.
+                <p/>
+                Assuming your public key ID is '709F7561' and your key is available
+                from the public key server 'pgp.mit.edu', the following command
+                will import the key on <tt>people.apache.org</tt>:
+                <pre class="codeConfig">
+ssh people.apache.org
+gpg --keyserver pgp.mit.edu --recv-keys 709F7561
+</pre>
+                Next verify the signature with the following command:
+                <pre class="codeConfig">
+ssh people.apache.org
+cd ~/public_html/release/X.X.X
+gpg --verify ClickIDE-X.X.X-incubating.zip.asc ClickIDE-X.X.X-incubating.zip
+</pre>
+            </li>
+            <li>
+                Releases must be voted on before they are published. Please
+                see the <a href="releasing.html#voting">Voting</a>
+                section for details.
+            </li>
+            <li>
+                Incubating releases are published at <tt>people.apache.org</tt> under
+                the folder:
+                <p/>
+                <tt>/www/www.apache.org/dist/incubator/click/<tt>SUBPROJECT</tt>/X.X.X</tt>
+
+                <p/>
+                <tt>SUBPROJECT</tt> should be replaced with the name of the subproject.
+                For example <tt>ClickIDE</tt> will be published to the folder:
+
+                <p/>
+                <tt>/www/www.apache.org/dist/incubator/click/clickide/X.X.X</tt>
+
+                <p/>
+                An easy way to do this is to copy the files in your <tt>public_html</tt>
+                folder for example:
+                <pre class="codeConfig">ssh people.apache.org
+cp ~/public_html/release/X.X.X/* /www/www.apache.org/dist/incubator/click/clickide/X.X.X
+</pre>
+            </li>
+             <li>
+                Email release announcement to <tt>click-user</tt> and <tt>click-dev</tt>
+                mailing lists.
+            </li>
+        </ol>
+
+        <p/>
+    </body>
+</html>

Modified: incubator/click/trunk/click/documentation/docs/developer-guide/releasing.html
URL: http://svn.apache.org/viewvc/incubator/click/trunk/click/documentation/docs/developer-guide/releasing.html?rev=731643&r1=731642&r2=731643&view=diff
==============================================================================
--- incubator/click/trunk/click/documentation/docs/developer-guide/releasing.html (original)
+++ incubator/click/trunk/click/documentation/docs/developer-guide/releasing.html Mon Jan  5 10:26:22 2009
@@ -40,12 +40,12 @@
         <p/>
         <b>Please note</b> this section is for committers only.
 
-        <h3>Prerequisites</h3>
+        <h3><a href="#" name="prerequisites"></a>Prerequisites</h3>
 
         Before creating a release ensure you have setup your own public OpenGPG key signature
-        for signing and encrypting the distribution.
+        for signing the distribution.
         <p/>
-        A OpenGPG key can be generated using <a class="external" target="_blank" href="http://www.gnupg.org/">GnuPG</a>.
+        An OpenGPG key can be generated using <a class="external" target="_blank" href="http://www.gnupg.org/">GnuPG</a>.
         There is also a <a class="external" target="_blank" href="http://www.gpg4win.org/">Windows</a> port available.
 
         <p/>
@@ -145,7 +145,7 @@
             </li>
         </ol>
 
-        <h3>Voting</h3>
+        <h3><a href="#" name="voting"></a>Voting</h3>
 
         Each release must be voted by the Incubator PMC on the <tt>click-dev</tt>
         mailing list and again on the <tt>general</tt> incubator list.