ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hi...@apache.org
Subject svn commit: r691536 - in /ant/ivy/core/trunk/doc: dev/makerelease.html dev/updatesite.html toc.json
Date Wed, 03 Sep 2008 08:16:21 GMT
Author: hibou
Date: Wed Sep  3 01:16:20 2008
New Revision: 691536

URL: http://svn.apache.org/viewvc?rev=691536&view=rev
Log:
Add the docuemntation about how to update the IvyDE updatesite

Added:
    ant/ivy/core/trunk/doc/dev/updatesite.html   (with props)
Modified:
    ant/ivy/core/trunk/doc/dev/makerelease.html
    ant/ivy/core/trunk/doc/toc.json

Modified: ant/ivy/core/trunk/doc/dev/makerelease.html
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/dev/makerelease.html?rev=691536&r1=691535&r2=691536&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/dev/makerelease.html (original)
+++ ant/ivy/core/trunk/doc/dev/makerelease.html Wed Sep  3 01:16:20 2008
@@ -127,7 +127,11 @@
 <h2>WARNING: files available here are NOT an Apache approved release yet.</h2>
 </code>
 
-<h3>11. Call for a vote to approve the release</h3>
+<h3>11. Prepare the Eclipse update site</h3>
+
+To be able to test the release within IvyDE, it can be deployed in the IvyDE update site.
See <a href="updatesite.html">that page</a> to know how to process.
+
+<h3>12. Call for a vote to approve the release</h3>
 Cast a vote to approve the release on the dev@ant.apache.org mailing list.
 
 Here is an example:
@@ -147,20 +151,20 @@
 
 ${me}, Ivy ${version} release manager
 </code>
-<h3>12. Tag the svn repository</h3>
+<h3>13. Tag the svn repository</h3>
 Now that the release is approved, it is time to tag the svn repo
 <code>
 svn copy https://svn.apache.org/repos/asf/ant/ivy/core/branches/2.0.0-beta1 \
            https://svn.apache.org/repos/asf/ant/ivy/core/tags/2.0.0-beta1 \
       -m "Tag release 2.0.0-beta1."
 </code>
-<h3>13. Upload to public repository</h3>
+<h3>14. Upload to public repository</h3>
 If the release is approved, it's now time to make it public by uploading it to the public
Apache distrib repository (i.e. /www/www.apache.org/dist/ant/ivy/[version] on people.a.o).
 
 Copy also the staging maven 2 repository to apache maven 2 rsync repo:
 /www/people.apache.org/repo/m2-ibiblio-rsync-repository
 
-<h3>14. Update the web site</h3>
+<h3>15. Update the web site</h3>
 Add a link to the released version documentation in the web site. 
 
 To do so, you need to:
@@ -203,7 +207,11 @@
 ant clean publish-site
 </code>
 
-<h3>15. Announce</h3>
+<h3>16. Deploy the Eclipse updatesite</h3>
+
+If the Eclipse update site has already been prepared to include that new Ivy release, it
is now needed to be deployed. Then follow the deployment instruction on <a href="updatesite.html">that
page<a>.
+
+<h3>17. Announce</h3>
 Announce the release on the dev@ant.a.o, ivy-user@ant.a.o, user@ant.apache.org and announce@apache.org
mailing lists.
 You can also announce the release on popular web sites, like freshmeat.net (xavier is the
owner of the Ivy project on freshmeat), javalobby.org, theserverside.com, dzone.com, ...
 <h3>16. Update this doc</h3>

Added: ant/ivy/core/trunk/doc/dev/updatesite.html
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/dev/updatesite.html?rev=691536&view=auto
==============================================================================
--- ant/ivy/core/trunk/doc/dev/updatesite.html (added)
+++ ant/ivy/core/trunk/doc/dev/updatesite.html Wed Sep  3 01:16:20 2008
@@ -0,0 +1,85 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.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">
+	<script type="text/javascript">var xookiConfig = {level: 1};</script>	
+	<script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+	<textarea id="xooki-source">
+Once a release have been build for Ivy or IvyDE, they should be push to the Eclipse updatesite
so that Eclipse users will be able to update automatically their installed version of Ivy
or IvyDE.
+
+<h1>Push the new version</h1>
+
+The update site svn location is there: https://svn.apache.org/repos/asf/ant/ivy/site/ivyde/updatesite/
+
+<ul>
+<li>For an <u>Ivy release</u>:
+the new ivy bundle have to be placed in the plugins directory of the updatesite. The convention
is to name the bundle org.apache.ivy_${BUNDLE-VERSION}.jar.
+Eclipse needs a feature, it can be generated at the right place with an ant target. From
the <a href="https://svn.apache.org/repos/asf/ant/ivy/site/build.xml">build file of
the site</a>, run: <pre>ant updatesite:generate-ivy-feature -Divy.version=${BUNDLE-VERSION}</pre>
+</li>
+<li>For an <u>IvyDE release</u>:
+it contains a plugin and a feature, so they have to be place respectivly in the plugins directory
and in the features directory. </li>
+</ul>
+
+Then the deprecated versions of the plugins and the features should be removed.
+
+And the site.xml file should be edited. The version number should be updated accordingly
to the release.
+
+<h1>Prepare the update site</h1>
+
+The update site is optimized: the metadata of the features are aggregated into the digest.zip,
and the jar of the plugins are compressed with a better algorithm.
+
+To accomplish this task, from the <a href="https://svn.apache.org/repos/asf/ant/ivy/site/build.xml">build
file of the site</a>, run:
+<pre>ant updatesite:optimize</pre>
+
+The binary files then need to be signed and their checksum computed. For the checksums, run:
+<pre>ant updatesite:checksum</pre>
+To sign the binaries, you can use the signArtifacts.sh scripts which is in the updatesite
directory.
+
+<h1>Test the updatesite</h1>
+
+The updatesite is ready to be tested. In order to test the new artifacts, as they are not
yet deployed on Apache mirrors, the updatesite mirroring have to be disable. Basically it
is just about not deploying the eclipse-update--xml files.
+
+If you are willing to just test yourself, you can setup in Eclipse a local updatesite. Wherever
you want on your local filesystem, make a clone of you working copy of the updatesite directory,
but <u>without</u> the eclipse-update--xml files.
+
+To let the developper community test the updatesite, you can copy the new local updatesite
<u>without</u> the eclipse-update--xml files to your public_html directory on
people.apache.org:
+<pre>scp -r digest.zip features plugins site.xml LOGIN@people.apache.org:/home/LOGIN/public_html/updatesite</pre>
+
+<h1>Deployment</h1>
+
+Two deployments are needed. One will be part of the website deployment, it will deploy the
main updatesite, where there are only the metadata. The second is about pushing the binaries
in the Apache dist directory.
+
+To deploy the main updatesite, juste regenerate the IvyDE site:
+<pre>ant generate-site-ivyde</pre>
+and commit the changes of the "target" directory.
+
+For the mirrors udpate site which contains the actual binaries, every binaries have to be
copied, with their signatures and checksums, and the site.xml. So on people.apache.org, first
do a backup of the current updatesite
+<pre>mv /www/www.apache.org/dist/ant/ivyde/updatesite /www/www.apache.org/dist/ant/ivyde/updatesite.bak</pre>
+Then we recreate the updatesite:
+<pre>mkdir /www/www.apache.org/dist/ant/ivyde/updatesite</pre>
+And publish the new updatesite:
+<pre>cd site/ivyde/updatesite
+scp -r digest* plugins features site.xml LOGIN@people.apache.org:/www/www.apache.org/dist/ant/ivyde/updatesite</pre>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Propchange: ant/ivy/core/trunk/doc/dev/updatesite.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ant/ivy/core/trunk/doc/dev/updatesite.html
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: ant/ivy/core/trunk/doc/dev/updatesite.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Modified: ant/ivy/core/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/toc.json?rev=691536&r1=691535&r2=691536&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/toc.json (original)
+++ ant/ivy/core/trunk/doc/toc.json Wed Sep  3 01:16:20 2008
@@ -777,6 +777,13 @@
                     "children": [
 
                       ]
+                  },
+                  {
+                    "id":"dev/updatesite",
+                    "title":"Updating the updatesite",
+                    "children": [
+
+                      ]
                   }
                 ]
             }



Mime
View raw message