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 2012/08/21 00:25:54 UTC

svn commit: r829510 - in /websites/staging/maventest/trunk/content: ./ developers/release/maven-plugin-release.html

Author: buildbot
Date: Mon Aug 20 22:25:53 2012
New Revision: 829510

Log:
Staging update by buildbot for maventest

Modified:
    websites/staging/maventest/trunk/content/   (props changed)
    websites/staging/maventest/trunk/content/developers/release/maven-plugin-release.html

Propchange: websites/staging/maventest/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Aug 20 22:25:53 2012
@@ -1 +1 @@
-1375279
+1375283

Modified: websites/staging/maventest/trunk/content/developers/release/maven-plugin-release.html
==============================================================================
--- websites/staging/maventest/trunk/content/developers/release/maven-plugin-release.html (original)
+++ websites/staging/maventest/trunk/content/developers/release/maven-plugin-release.html Mon Aug 20 22:25:53 2012
@@ -221,10 +221,11 @@ Hervé Boutemy" />
     </div>
     <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 Plugin<a name="Releasing_A_Maven_Plugin"></a></h2><p>Rele
 asing a Maven plugin 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 plugins 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 plugin parent POM will be configured (TODO) to publish the documentation in Apache svn https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-latest.</p><p>Stage the documentation for the current release version (not the new snapshot).</p><div class="source"><pre>cd target/checkout
+        <!-- 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 Plugin<a name="Releasing_A_Maven_Plugin"></a></h2><p>Rele
 asing a Maven plugin 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 plugins 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 plugin parent POM will be configured (TODO) to publish the documentation in Apache svn https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-staging.</p><p>Stage the documentation for the current release version (not the new snapshot).</p><div class="source"><pre>cd target/checkout
 
 mvn -Preporting site site:stage scm-publish:publish-scm \
-    -Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-staging</pre></div><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/cms.html#svnpubsub">snvpubsub</a>), which should be a matter of seconds.</p><div class="source"><pre>http://maven.apache.org/plugins/maven-XXX-plugin-staging/</pre></div></div><div class="section"><h3>Publishing the release website<a name="Publishing_the_release_website"></a></h3><p>After the release has passed, the site needs to be updated:</p><ol style="list-style-type: decimal"><li>cut the new release +------+ svn cp https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-staging <br />https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-Y.Z +------+</li><li>declare the <tt>plugins/ma
 ven-XXX-plugin-Y.Z</tt> directory in <a href="/extpaths.txt">extpaths.txt</a>, locally or <a class="externalLink" href="https://cms.apache.org/redirect?uri=http://maventest.apache.org/extpaths.txt&amp;action=edit">with the CMS</a>.</li><li>edit the content/filtered-resources/.htaccess file (locally or <a class="externalLink" href="https://cms.apache.org/redirect?uri=http://maventest.apache.org/filtered-resources/.htaccess&amp;action=edit">with the CMS</a>) to update rewrite rule<div class="source"><pre>RewriteRule ^plugins/maven-XXX-plugin/(.*)$ /plugins/maven-XXX-plugin-Y.Z/$1 [L]</pre></div></li></ol></div><div class="section"><h3>Updating the Maven site<a name="Updating_the_Maven_site"></a></h3><p>Use the CMS to update <a href="/plugins/">the plugins page</a>, made easy with <a class="externalLink" href="https://cms.apache.org/#bookmark">the CMS bookmarklet</a>.</p></div><div class="section"><h3>idea to be developped if sufficient people is interested<a name="idea_to_be_d
 evelopped_if_sufficient_people_is_interested"></a></h3><p>Instead of doing command line svn and extpaths.txt + .htaccess edits, the staging/release operations could be automated as web ui like following:</p><ul><li>http://cms.apache.org/maventest/release/plugins/maven-xxx-plugin-X.Y could display a page proposing to <b>stage the release documentation</b> (doing svn command and .htaccess edit)</li><li>next time this page is displayed, with the content already available in svn, the page could propose 2 different actions: <b>drop the staged documentation</b> (with extpaths.txt removal) or <b>publish the release website</b>.</li></ul></div></div>
+    -Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-staging</pre></div><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/cms.html#svnpubsub">snvpubsub</a>), which should be a matter of seconds.</p><div class="source"><pre>http://maven.apache.org/plugins/maven-XXX-plugin-staging/</pre></div></div><div class="section"><h3>Publishing the release website<a name="Publishing_the_release_website"></a></h3><p>After the release has passed, the site needs to be updated:</p><ol style="list-style-type: decimal"><li>cut the new release<div class="source"><pre>svn cp https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-staging \
+       https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-Y.Z</pre></div></li><li>declare the <tt>plugins/maven-XXX-plugin-Y.Z</tt> directory in <a href="/extpaths.txt">extpaths.txt</a>, locally or <a class="externalLink" href="https://cms.apache.org/redirect?uri=http://maventest.apache.org/extpaths.txt&amp;action=edit">with the CMS</a>.</li><li>edit the content/filtered-resources/.htaccess file (locally or <a class="externalLink" href="https://cms.apache.org/redirect?uri=http://maventest.apache.org/filtered-resources/.htaccess&amp;action=edit">with the CMS</a>) to update rewrite rule<div class="source"><pre>RewriteRule ^plugins/maven-XXX-plugin/(.*)$ /plugins/maven-XXX-plugin-Y.Z/$1 [L]</pre></div></li></ol></div><div class="section"><h3>Updating the Maven site<a name="Updating_the_Maven_site"></a></h3><p>Use the CMS to update <a href="/plugins/">the plugins page</a>, made easy with <a class="externalLink" href="https://cms.apa
 che.org/#bookmark">the CMS bookmarklet</a>.</p></div><div class="section"><h3>idea to be developped if sufficient people is interested<a name="idea_to_be_developped_if_sufficient_people_is_interested"></a></h3><p>Instead of doing command line svn and extpaths.txt + .htaccess edits, the staging/release operations could be automated as web ui like following:</p><ul><li>http://cms.apache.org/maventest/release/plugins/maven-xxx-plugin-X.Y could display a page proposing to <b>stage the release documentation</b> (doing svn command and .htaccess edit)</li><li>next time this page is displayed, with the content already available in svn, the page could propose 2 different actions: <b>drop the staged documentation</b> (with extpaths.txt removal) or <b>publish the release website</b>.</li></ul></div></div>
       </div>
     </div>
     <div class="clear">