Author: hibou
Date: Wed Oct 1 13:56:39 2008
New Revision: 700917
URL: http://svn.apache.org/viewvc?rev=700917&view=rev
Log:
Improve the updatesite doc, simplify the process by using the svn export command
Modified:
ant/ivy/core/trunk/doc/dev/updatesite.html
Modified: ant/ivy/core/trunk/doc/dev/updatesite.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/dev/updatesite.html?rev=700917&r1=700916&r2=700917&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/dev/updatesite.html (original)
+++ ant/ivy/core/trunk/doc/dev/updatesite.html Wed Oct 1 13:56:39 2008
@@ -35,17 +35,17 @@
<h2>Push the new version</h2>
-The update site svn location is there:
https://svn.apache.org/repos/asf/ant/ivy/site/ivyde/updatesite/ . You will
update it so it will contain the new artifacts.
+The update site svn location is there:
https://svn.apache.org/repos/asf/ant/ivy/updatesite/trunk . You will update it
so it will contain the new artifacts.
-<ul><li>For an <u>Ivy release</u>:
+<ul><li>For an <u>Ivy</u> release:
The new ivy bundle have to be placed in the plugins directory of the
updatesite. So you should do something like:
-<code>cp folder/ivy.jar dist/plugins/org.apache.ivy_$VERSION.jar</code>
+<code>cp ..../ivy.jar dist/plugins/org.apache.ivy_$VERSION.jar</code>
-Then Eclipse needs a feature, which will be generated at the right place with
an ant target. At the root of your working copy of the website, run:
+Then Eclipse needs a feature, which will be generated at the right place with
an ant target:
<pre>
ant generate-ivy-feature -Divy.version=$VERSION</pre>
</li><li>
-For an <u>IvyDE release:</u>
+For an <u>IvyDE</u> release:
The zip distribution needs to be unpacked into the updatesite directory:
<pre>
cd dist
@@ -58,20 +58,20 @@
<h2>Update the site.xml</h2>
-The site.xml file should be edited so it will reference the new artifacts. You
should just change the version number accordingly to the release.
+The <tt>site.xml</tt> file in the <tt>dist</tt> directory should be edited so
it will reference the new artifacts. You should just change the version number
accordingly to the release.
<h2>Prepare the update site</h2>
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, just run an ant task at the root of your working copy
of the updatesite:
+To accomplish this task, just run at the root of your working copy of the
updatesite:
<ul>
-<li>For an <u>Ivy</u> release
+<li>For an <u>Ivy</u> release:
<pre>
ant optimize-ivy
</pre></li>
<li>
-For an <u>IvyDE</u> release
+For an <u>IvyDE</u> release:
<pre>
ant optimize-ivyde
</pre></li>
@@ -80,83 +80,45 @@
The binary files then need to be signed and their checksum computed. For the
checksums, run:
<pre>ant checksum</pre>
And sign the binaries:
-<pre>./signArtifacts.sh</pre>
-<b>Note:</b> these previous tasks may optimize, checksum and sign already
released artifacts. Just so a <tt>svn status</tt> to check the modified
artifacts; the only modified files should be the digest.zip (with its signature
and checksum) and the site.xml. Then do some <tt>svn revert <i>file</i></tt> to
revert the unexpected changes.
-
-<h2>Test the updatesite</h2>
-
-The updatesite is ready to be tested.
+<ul>
+<li>For an <u>Ivy</u> release:
+<pre>./signIvyArtifacts.sh</pre>
+</li>
+<li>
+For an <u>IvyDE</u> release:
+<pre>./signIvyDEArtifacts.sh</pre>
+</li>
+</ul>
-<h3>Local test:</h3>
+<b>Note:</b> these previous targets may optimize, checksum and sign already
released artifacts. Just so a <tt>svn status</tt> to check the modified
artifacts; the only modified files should be the digest.zip (with its signature
and checksum) and the site.xml; then there should be the added files of the
release. Then do some <tt>svn revert <i>file</i></tt> to revert the unexpected
changes.
-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.
+And finally commit your changes.
-<h3>On people.apache.org</h3>
+<h2>Test the updatesite</h2>
-To let the developper community test the updatesite, you can copy the new
local updatesite to your public_html directory on people.apache.org. You should
also avoid copying the .svn directories. So on people.apache.org:
-<pre>mkdir ~/public_html/staging-updatesite
~/public_html/staging-updatesite/plugins
~/public_html/staging-updatesite/features</pre>
-And then in your working copy:
-<pre>
-scp dist/digest.zip* dist/site.xml [EMAIL
PROTECTED]:/home/$LOGIN/public_html/staging-updatesite
-scp dist/features/org.apache.ivy* [EMAIL
PROTECTED]:/home/$LOGIN/public_html/staging-updatesite/features
-scp dist/plugins/org.apache.ivy* [EMAIL
PROTECTED]:/home/$LOGIN/public_html/staging-updatesite/plugins
+The updatesite is ready to be tested. You can deploy it where ever you want
with the command:
+<pre>svn export https://svn.apache.org/repos/asf/ant/ivy/updatesite/trunk/dist
updatesite
</pre>
-<h3>Disable mirrors</h3>
-
For both local and remote testing, as the new jars are not yet deployed on
Apache mirrors, the updatesite mirroring have to be disable.
-Basically it is just about modifying the site.xml and remove the reference to
the eclipse-update--xml files:
-<code>
-Index: site.xml
-===================================================================
---- site.xml (révision 700482)
-+++ site.xml (copie de travail)
-@@ -18,7 +18,6 @@
- under the License.
- -->
- <site pack200="true"
--
mirrorsURL="http://ant.apache.org/ivy/ivyde/updatesite/eclipse-update--xml.cgi";
- digestURL="./">
- <description url="http://ant.apache.org/ivy/ivyde/updatesite";>
- Eclipse update site for Apache IvyDE.
-</code>
+Basically it is just about modifying the site.xml and remove the reference to
the eclipse-update--xml files: remove the attribute <tt>mirrorsURL</tt>.
+
+To let the developper community test the updatesite, you can setup a staging
updatesite in your public_html directory on people.apache.org. So if you deploy
it on people.apache.org, in the directory ~/public_html/staging, then the
developpers should setup the updatesite with the URL
http://people.apache.org/~LOGIN/staging/updatesite .
<h1><a name="deployment"></a>Deployment of a release</h1>
-The release is accepeted, so we can tag the updatesite:
+The release is accepted, so we can tag the updatesite:
<pre>
svn cp https://svn.apache.org/repos/asf/ant/ivy/updatesite/trunk
https://svn.apache.org/repos/asf/ant/ivy/updatesite/tags/$TAGNAME
</pre>
-with $TAGNAME the name of the release, so it would be either ivy-$VERSION or
ivyde-$VERSION
-
-First backup the current updatesite. On people.apache.org:
-<pre>
-mkdir ~/updatesite.backup
-cp -R /www/ant.apache.org/ivy/ivyde/updatesite ~/updatesite.backup
-</pre>
-
-Then, upload the new updatesite from your working copy to people.apache.org.
On people.apache.org
-<pre>
-mkdir ~/updatesite ~/updatesite/features ~/updatesite/plugins
-</pre>
-And then the copy (it basically copies every file in dist without the .svn
directories):
-<pre>
-scp dist/digest.zip* dist/site.xml [EMAIL PROTECTED]:/home/$LOGIN/updatesite
-scp dist/features/org.apache.ivy* [EMAIL
PROTECTED]:/home/$LOGIN/updatesite/features
-scp dist/plugins/org.apache.ivy* [EMAIL
PROTECTED]:/home/$LOGIN/updatesite/plugins
-</pre>
-
-Once you checked that the copy in your home directory is OK (basically check
that every file is here), deploy it in dist. On people.apache.org:
-<pre>
-rm -rf /www/ant.apache.org/ivy/ivyde/updatesite
-cp -R ~/updatesite /www/ant.apache.org/ivy/ivyde/
-</pre>
+with <tt>$TAGNAME</tt> the name of the release, so it would be either
<tt>ivy-$VERSION</tt> or <tt>ivyde-$VERSION</tt>.
-And finally you might want to make it writable for the ant group:
+Then backup and deploy. On people.apache.org:
<pre>
-chown -R $LOGIN:ant /www/ant.apache.org/ivy/ivyde/updatesite
-chmod -R g+w /www/ant.apache.org/ivy/ivyde/updatesite
+cd /www/www.apache.org/dist/ant/ivyde/
+mv updatesite ~/updatesite.backup
+svn export
https://svn.apache.org/repos/asf/ant/ivy/updatesite/tags/$TAGNAME/dist
updatesite
</pre>
<h2>Deprecated updatesite</h2>
@@ -165,8 +127,8 @@
In your local svn working copy do:
<pre>
-cp updatesite/trunk/dist/digest.zip* site/ivyde/updatesite/
-cp updatesite/trunk/dist/site.xml site/ivyde/updatesite/
+cp updatesite/trunk/dist/digest.zip* site/ivyde/updatesite
+cp updatesite/trunk/dist/site.xml site/ivyde/updatesite
</pre>
And commit the changes of the website.
Next is the usual IvyDE website deployment:
@@ -177,7 +139,6 @@
And on people.apache.org:
<pre>
svn up /www/ant.apache.org/ivy/ivyde/updatesite
-chmod -R g+w /www/ant.apache.org/ivy/ivyde/updatesite
</pre>
</textarea>
<script type="text/javascript">xooki.postProcess();</script>
