You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2013/12/07 17:50:07 UTC
svn commit: r1548939 - in /maven/site/trunk/content/apt/developers/release:
maven-project-release-procedure.apt parent-pom-release.apt releasing.apt
Author: hboutemy
Date: Sat Dec 7 16:50:07 2013
New Revision: 1548939
URL: http://svn.apache.org/r1548939
Log:
updated documentation to match the actual differences: only Maven core and POMs have specific parts, shared and plugins are like any other component/project
Modified:
maven/site/trunk/content/apt/developers/release/maven-project-release-procedure.apt
maven/site/trunk/content/apt/developers/release/parent-pom-release.apt
maven/site/trunk/content/apt/developers/release/releasing.apt
Modified: maven/site/trunk/content/apt/developers/release/maven-project-release-procedure.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/developers/release/maven-project-release-procedure.apt?rev=1548939&r1=1548938&r2=1548939&view=diff
==============================================================================
--- maven/site/trunk/content/apt/developers/release/maven-project-release-procedure.apt (original)
+++ maven/site/trunk/content/apt/developers/release/maven-project-release-procedure.apt Sat Dec 7 16:50:07 2013
@@ -75,11 +75,7 @@ Performing a Maven Project Release
[[1]] Follow the release preparation, staging and closing the repository steps outlined in {{{http://www.apache.org/dev/publishing-maven-artifacts.html#staging-maven}Staging a Maven release}}.
- [[2]] Stage the latest documentation
-
- If your project uses Maven to generate documentation and it is not included as part of
- the release process, stage it now for inclusion in the release vote. For Maven projects,
- refer to the specific instructions for the project you are releasing.
+ [[2]] Stage the latest documentation as explained in {{{../website/deploy-component-reference-documentation.html}deploying Maven components reference documentation}}.
* Call the vote
Modified: maven/site/trunk/content/apt/developers/release/parent-pom-release.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/developers/release/parent-pom-release.apt?rev=1548939&r1=1548938&r2=1548939&view=diff
==============================================================================
--- maven/site/trunk/content/apt/developers/release/parent-pom-release.apt (original)
+++ maven/site/trunk/content/apt/developers/release/parent-pom-release.apt Sat Dec 7 16:50:07 2013
@@ -4,7 +4,7 @@
Hervé Boutemy
Dennis Lundberg
-----
- 2012-11-04
+ 2013-12-07
-----
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -31,7 +31,7 @@ Releasing A Parent POM
* {{{./maven-project-release-procedure.html} Maven Project Common Release procedure}}
- Note that Parent POMs have particular conventions for managing and deploying the project site.
+ Note that Parent POMs have particular conventions for managing and deploying the documentation.
* Rationale
@@ -74,36 +74,15 @@ Releasing A Parent POM
* Staging the latest documentation
- Once the release is prepared, but before the release vote, the site needs to be staged.
+ Instructions for staging latest documentation are the same as {{{../website/deploy-component-reference-documentation.html}standard component}},
+ with the addition of <<<-f site-pom.xml>>>.
- The parent POMs are configured to stage the documentation in a "versioned" directory
- such as <<</pom/XXX-Y>>>.
-
- [[1]] Stage the documentation for the current release version (not the new snapshot).
+ Then the only difference is with commands to stage the site:
+------+
cd target/checkout
-mvn -f site-pom.xml site site:stage-deploy
-+------+
-
- <<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}}).
-
-+-----+
-http://maven.apache.org/pom/XXX-Y/
-+-----+
-
- [[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/pom
-find . -type d -exec chmod a+rx,g+w {} \;
-find . -type f -exec chmod 664 {} \;
+mvn -f site-pom.xml site
+mvn -f site-pom.xml scm-publish:publish-scm
+------+
* Call the vote
@@ -121,40 +100,3 @@ http://svn.apache.org/viewvc/maven/pom/t
Staging repo:
...
+-----+
-
-* 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>>>)
-
-+-----+
-cd target/checkout
-mvn -f site-pom.xml site-deploy
-+-----+
-
- <<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}}
-
- To review the site, wait for the files to arrive at
-
-+-----+
-http://maven.apache.org/pom/XXX/
-+-----+
-
- 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 and release date for the parent POM on the <<<src/site/apt/pom/index.apt>>> page.
-
- Commit your changes and then deploy the site.
-
-+-----+
-mvn clean site-deploy
-+-----+
Modified: maven/site/trunk/content/apt/developers/release/releasing.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/developers/release/releasing.apt?rev=1548939&r1=1548938&r2=1548939&view=diff
==============================================================================
--- maven/site/trunk/content/apt/developers/release/releasing.apt (original)
+++ maven/site/trunk/content/apt/developers/release/releasing.apt Sat Dec 7 16:50:07 2013
@@ -25,15 +25,15 @@
Releasing A Maven Project
- What follows is a description of releasing a Maven project to a staging repository, whereupon it is scrutinized by
- the community, approved, and transferred to a production repository.
+ What follows is a description of releasing a Maven project to a staging repository and its documentation, whereupon
+ it is scrutinized by the community, approved, and transferred to a production repository.
- The steps involved are similar for any Apache project, with more specifics for Maven plugins, shared libraries, and
+ The steps involved are similar for any Apache project, with more specifics for parent POMs and
Maven itself. The steps involved, and the relevant documents for each, are listed below.
- * {{{./maven-plugin-release.html} Releasing a Maven plugin project}}
+~~ nothing specific: normal component * {{{./maven-plugin-release.html} Releasing a Maven plugin project}}
- * {{{./maven-shared-release.html} Releasing a Maven shared component or subproject}}
+~~ nothing specific: normal component * {{{./maven-shared-release.html} Releasing a Maven shared component or subproject}}
* {{{./maven-core-release.html} Releasing Maven Core}}