Author: hboutemy
Date: Mon Mar 12 02:37:33 2012
New Revision: 1299531
URL: http://svn.apache.org/viewvc?rev=1299531&view=rev
Log:
trial at precise component site release instructions
Modified:
maven/site/branches/INFRA-4466/trunk/content/apt/developers/release/maven-plugin-release.apt
Modified:
maven/site/branches/INFRA-4466/trunk/content/apt/developers/release/maven-plugin-release.apt
URL:
http://svn.apache.org/viewvc/maven/site/branches/INFRA-4466/trunk/content/apt/developers/release/maven-plugin-release.apt?rev=1299531&r1=1299530&r2=1299531&view=diff
==============================================================================
---
maven/site/branches/INFRA-4466/trunk/content/apt/developers/release/maven-plugin-release.apt
(original)
+++
maven/site/branches/INFRA-4466/trunk/content/apt/developers/release/maven-plugin-release.apt
Mon Mar 12 02:37:33 2012
@@ -2,8 +2,9 @@
Releasing A Maven Plugin
-----
Jason van Zyl
+ Hervé Boutemy
-----
- 2010-11-25
+ 2012-03-12
-----
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -37,79 +38,42 @@ Releasing A Maven Plugin
Once the release is prepared, but before the release vote, the site needs to
be staged.
- The plugin parent POM is configured to stage the documentation in a
"versioned" directory
- such as <<</plugins/maven-XXX-plugin-Y.Z>>>.
+ The plugin parent POM will be configured (TODO) to publish the documentation
in Apache svn
+ https://svn.apache.org/repos/infra/websites/production/maventest/latest
(directory name to be discussed to match the intent).
[[1]] Stage the documentation for the current release version (not the new
snapshot).
+------+
cd target/checkout
-mvn site site:stage-deploy -Preporting
+mvn site-deploy -Preporting
+svn cp
https://svn.apache.org/repos/infra/websites/production/maventest/latest/plugins/maven-XXX-plugin
\
+
https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-XXX-plugin-Y.Z
+------+
- <<Note:>> It requires Maven 2.1.0 or higher to successfully deploy to
<<<people.apache.org>>> via SSH. Older Maven
- versions will fail due to <<<com.jcraft.jsch.JSchException: Algorithm
negotiation fail>>>.
-
<<Note:>> You should verify the deployment of the site on the Maven website
- (you need to wait {{{http://www.apache.org/dev/project-site.html}the
sync}}).
+ (you need to wait
{{{http://www.apache.org/dev/cms.html#svnpubsub}snvpubsub}}), which should be a
matter of seconds.
+-----+
http://maven.apache.org/plugins/maven-XXX-plugin-Y.Z/
+-----+
- Some developers have
{{{http://www.nabble.com/site%3Astage-deploy-asks-for-a-password--tt15582961s177.html}
- reported problems}} with the <<<site:stage-deploy>>> goal. In that case,
you can stage the site locally and
- upload it manually:
-
-+------+
-mvn site site:stage -Preporting
-scp -r
target/staging/people.apache.org/www/maven.apache.org/plugins/maven-XXX-plugin
[email protected]:/www/maven.apache.org/plugins/maven-XXX-plugin-Y.Z
-+------+
-
- [[2]] Verify/change folder permissions to 0775 and files permissions to
0664. Log on to <<<people.apache.org>>> and
- change to the directory above the staging directory.
- Then run these commands:
-
-+------+
-cd /www/maven.apache.org/plugins
-find . -type d -exec chmod a+rx,g+w {} \;
-find . -type f -exec chmod 664 {} \;
-+------+
-
* Deploying the release website
After the release has passed, the site needs to be uploaded.
- <<Note:>> 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 <<<target/checkout>>>)
+ TODO: make choice between multiple solutions:
-+-----+
-cd target/checkout
-mvn site-deploy -Preporting
-+-----+
-
- <<Note:>> 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
{{http://www.nabble.com/forum/ViewPost.jtp?post=24018250&framed=y}}
+ [[a]] svn copy
- To review the site, wait for the files to arrive at
++-------+
+svnmucc -U
https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins
\
+ rm maven-XXX-plugin cp maven-XXX-plugin-Y.Z maven-XXX-plugin
++-------+
-+-----+
-http://maven.apache.org/plugins/maven-XXX-plugin/
-+-----+
+ [[b]] change symlink: TODO find an easy way to change a symlink created in
svn, like
https://svn.apache.org/repos/infra/websites/production/maventest/content/ant-tasks
- The wait is necessary to allow the site to be
- {{{http://www.apache.org/dev/project-site.html}rsync'ed into production}}.
+ []
* Updating the Maven site
- Check out the maven site project from
<<<https://svn.apache.org/repos/asf/maven/site/trunk>>> or pull the latest
- changes if already checked out.
-
- Update the version number for the plugin on the
<<<src/site/apt/plugins/index.apt>>> page.
-
- Commit your changes and then deploy the site.
-
-+-----+
-mvn clean site-deploy
-+-----+
-
+ Use the CMS to update {{{http://maventest.apache.org/plugins/}/plugins/}}
page, made easy with the bookmarklet.
