You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bu...@apache.org on 2013/02/23 23:34:46 UTC
svn commit: r851736 - in /websites/staging/maven/trunk/content: ./
developers/release/maven-shared-release.html maven-site-1.0-site.jar
Author: buildbot
Date: Sat Feb 23 22:34:45 2013
New Revision: 851736
Log:
Staging update by buildbot for maven
Modified:
websites/staging/maven/trunk/content/ (props changed)
websites/staging/maven/trunk/content/developers/release/maven-shared-release.html
websites/staging/maven/trunk/content/maven-site-1.0-site.jar
Propchange: websites/staging/maven/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sat Feb 23 22:34:45 2013
@@ -1 +1 @@
-1449418
+1449419
Modified: websites/staging/maven/trunk/content/developers/release/maven-shared-release.html
==============================================================================
--- websites/staging/maven/trunk/content/developers/release/maven-shared-release.html (original)
+++ websites/staging/maven/trunk/content/developers/release/maven-shared-release.html Sat Feb 23 22:34:45 2013
@@ -14,7 +14,7 @@
<link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
<meta name="author" content="Jason van Zyl
bimargulies" />
- <meta name="Date-Creation-yyyymmdd" content="20110619" />
+ <meta name="Date-Creation-yyyymmdd" content="20130223" />
<meta name="Date-Revision-yyyymmdd" content="20130223" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -234,15 +234,9 @@ bimargulies" />
<div id="bodyColumn">
<div id="contentBox">
<!-- 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. --><div class="section"><h2>Releasing A Maven Shared Component<a name="Releasing_A_Maven_Shared_Compone
nt"></a></h2><p>Releasing a Maven component is much the same as any other Maven project. The following guide walks through most of the steps:</p><ul><li><a href="./maven-project-release-procedure.html"> Maven Project Common Release procedure</a></li></ul><p>Note that components have particular conventions for deploying the project site. When encountered in the release process above, perform the following steps:</p><div class="section"><h3>Staging the latest documentation<a name="Staging_the_latest_documentation"></a></h3><p>Once the release is prepared, but before the release vote, the site needs to be staged.</p><p>The shared component parent POM is configured to stage the documentation in a "versioned" directory such as <tt>/shared/maven-XXX-Y.Z</tt>.</p><ol style="list-style-type: decimal"><li>Stage the documentation for the current release version (not the new snapshot).<div class="source"><pre>cd target/checkout
-mvn site site:stage-deploy -Preporting</pre></div><p><b>Note:</b> It requires Maven 2.1.0 or higher to successfully deploy to <tt>people.apache.org</tt> via SSH. Older Maven versions will fail due to <tt>com.jcraft.jsch.JSchException: Algorithm negotiation fail</tt>.</p><p><b>Note:</b> You should verify the deployment of the site on the Maven website (you need to wait <a class="externalLink" href="http://www.apache.org/dev/project-site.html">the sync</a>).</p><div class="source"><pre>http://maven.apache.org/shared/maven-XXX-Y.Z/</pre></div><p>Some developers have <a class="externalLink" href="http://www.nabble.com/site%3Astage-deploy-asks-for-a-password--tt15582961s177.html"> reported problems</a> with the <tt>site:stage-deploy</tt> goal. See the discussion of settings.xml below for one possible solution. If that doesn't work, you can stage the site locally and upload it manually:</p><div class="source"><pre>mvn site site:stage -Preporting
-scp -r target/staging/people.apache.org/www/maven.apache.org/shared/maven-XXX YOUR_APACHE_USERNAME@people.apache.org:/www/maven.apache.org/shared/maven-XXX-Y.Z</pre></div></li><li>Verify/change folder permissions to 0775 and files permissions to 0664. Log on to <tt>people.apache.org</tt> and change to the directory above the staging directory. Then run these commands:<div class="source"><pre>cd /www/maven.apache.org/shared
-find . -type d -exec chmod a+rx,g+w {} \;
-find . -type f -exec chmod 664 {} \;</pre></div></li></ol></div><div class="section"><h3>Deploying the release website<a name="Deploying_the_release_website"></a></h3><p>After the release has passed, the site needs to be uploaded.</p><p><b>Note:</b> Be sure to generate and deploy the site using the same version of the release. Typically, you need to check out the tag (or go to <tt>target/checkout</tt>)</p><p>You will need to have your people.apache.org credentials in your settings.xml, and you may have to explicitly specify the server ID on the command line to persuade maven to use them. </p><p>Due to an apparent problem with the site plugin, passwords don't work reliably for this purpose. SSH keys do. As per the doc for settings.xml, Maven ignores a private key in settings.xml if it sees a password. So, to deploy a site, you should make sure that your settings.xml contains something like:</p><div class="source"><pre> <server>
- <id>apache.website</id>
- <username>mortimerqsnerd</username>
- <privateKey>${user.home}/.ssh/id_rsa</privateKey>
- </server></pre></div><div class="source"><pre>cd target/checkout
-mvn site-deploy -Preporting -DstagingRepositoryId=apache.website</pre></div><p><b>Note:</b> You can not just copy the documentation from the staging site above into the released documentation as the links are not identical. See the email thread <a class="externalLink" href="http://www.nabble.com/forum/ViewPost.jtp?post=24018250&framed=y">http://www.nabble.com/forum/ViewPost.jtp?post=24018250&framed=y</a></p><p>To review the site, wait for the files to arrive at</p><div class="source"><pre>http://maven.apache.org/shared/maven-XXX/</pre></div><p>The wait is necessary to allow the site to be <a class="externalLink" href="http://www.apache.org/dev/project-site.html">rsync'ed into production</a>.</p></div><div class="section"><h3>Updating the Maven site<a name="Updating_the_Maven_site"></a></h3><p>Check out the maven site project from <tt>https://svn.apache.org/repos/asf/maven/site/trunk</tt> or pull the latest changes if already checked out.</p><p>Update the version numb
er for the component on the <tt>src/site/apt/shared/index.apt</tt> page.</p><p>Commit your changes and then deploy the site.</p><div class="source"><pre>mvn clean site-deploy</pre></div></div></div>
+mvn site site:deploy -Preporting</pre></div></li></ol><p>deployed to http://maven.apache.org/shared-archives/maven-XXX-Y.Z/</p></div><div class="section"><h3>Deploying the release website<a name="Deploying_the_release_website"></a></h3><p>After the release has passed, the site needs to be uploaded.</p><p><b>Note:</b> Be sure to generate and deploy the site using the same version of the release. Typically, you need to check out the tag (or go to <tt>target/checkout</tt>)</p><p>+-----+ cd target/checkout mvn site-deploy -Preporting -Psite-release +-----+</p><p>Or </p><div class="source"><pre>csvn rm https://svn.apache.org/repos/infra/websites/production/maven/content/shared/maven-XXX
+svn cp https://svn.apache.org/repos/infra/websites/production/maven/content/shared-archives/maven-XXX-Y.Z \
+ https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-</pre></div><p>To review the site, wait for the files to arrive at</p><div class="source"><pre>http://maven.apache.org/shared/maven-XXX/</pre></div></div></div>
</div>
</div>
<div class="clear">
Modified: websites/staging/maven/trunk/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.