maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject svn commit: r1403593 - in /maven/site/trunk/src/site/apt/developers/release: maven-project-release-procedure.apt parent-pom-release.apt releasing.apt
Date Tue, 30 Oct 2012 01:09:49 GMT
Author: hboutemy
Date: Tue Oct 30 01:09:48 2012
New Revision: 1403593

URL: http://svn.apache.org/viewvc?rev=1403593&view=rev
Log:
added release instructions for parent POMs

Added:
    maven/site/trunk/src/site/apt/developers/release/parent-pom-release.apt   (with props)
Modified:
    maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt
    maven/site/trunk/src/site/apt/developers/release/releasing.apt

Modified: maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt?rev=1403593&r1=1403592&r2=1403593&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt (original)
+++ maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt Tue
Oct 30 01:09:48 2012
@@ -53,6 +53,10 @@ Performing a Maven Project Release
   
   * {{{./maven-core-release.html} Releasing Maven Core}}
 
+  * {{{./parent-pom-release.html} Releasing a parent POM}}
+
+  []
+
 * Consider updating the parent versions
 
   If the item you are planning to release is not using the most recent version of its parent

Added: maven/site/trunk/src/site/apt/developers/release/parent-pom-release.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/release/parent-pom-release.apt?rev=1403593&view=auto
==============================================================================
--- maven/site/trunk/src/site/apt/developers/release/parent-pom-release.apt (added)
+++ maven/site/trunk/src/site/apt/developers/release/parent-pom-release.apt Tue Oct 30 01:09:48
2012
@@ -0,0 +1,85 @@
+ -----
+ Releasing A Parent POM
+ -----
+ Hervé Boutemy
+ -----
+ 2012-10-29
+ -----
+
+~~ 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.
+
+Releasing A Parent POM
+
+  Releasing a Parent POM is much the same as any other Maven project. The following
+  guide walks through most of the steps:
+
+    * {{{./maven-project-release-procedure.html} Maven Project Common Release procedure}}
+  
+  Note that Parent POMs have particular conventions for managing and deploying the project
site.
+
+* Rationale
+
+  To be able to publish a documentation of the parent POM without affecting released POM
and <<<site.xml>>>,
+  parent POM projects have a specific structure, with the addition of <<<site-pom.xml>>>
and <<<src/site-docs>>>
+  provind <<<mvn -f site-pom.xml site>>>:
+
++----+
+|-- pom.xml
+|-- site-pom.xml
+`-- src
+    |-- site
+    |   `-- site.xml
+    `-- site-docs
+        |-- apt
+        |   `-- index.apt
+        `-- site.xml
++----+
+
+  And the <<<index.apt>>> page not only contains instructions about the
content of the parent POM, but
+  it maintains an historic of pom releases links and diffs.
+
+  Each specific step is done to maintain <<<site-pom.xml>>> and <<<index.apt>>>
in sync with the release being realeased.
+
+* Stage the release
+
+  Before staging the release with usual procedure, you need to update <<<site-pom.xml>>>
and <<<index.apt>>> to
+  take the future release into account:
+
+  [[1]] update <<<site-pom.xml>>> parent pom version to match the version
being released,
+
+  [[2]] update <<<src/site-docs/index.apt>>>: add a line in the history
of <<<pom.xml>>> for the future version, referring
+  to the future svn release tag and date. Hint: in the diff link, value for <<<r2>>>
parameter is easily found by
+  following previous version link and copying revision number.
+
+  []
+
+  Once these modifications are done, you can follow standard staging steps taking care to
use the <<<site-pom.xml>>> pom,
+  with <<<mvn -f site-pom.xml ...>>> command, each time the parent POM's
site is generated.
+
+* 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 parent POM on the <<<src/site/apt/pom/index.apt>>>
page.
+
+ Commit your changes and then deploy the site.
+
++-----+
+mvn clean site-deploy
++-----+

Propchange: maven/site/trunk/src/site/apt/developers/release/parent-pom-release.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/site/trunk/src/site/apt/developers/release/parent-pom-release.apt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: maven/site/trunk/src/site/apt/developers/release/releasing.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/release/releasing.apt?rev=1403593&r1=1403592&r2=1403593&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/developers/release/releasing.apt (original)
+++ maven/site/trunk/src/site/apt/developers/release/releasing.apt Tue Oct 30 01:09:48 2012
@@ -37,6 +37,8 @@ Releasing A Maven Project
   
   * {{{./maven-core-release.html} Releasing Maven Core}}
   
+  * {{{./parent-pom-release.html} Releasing a parent POM}}
+  
   []
 
   The above links all provide specific information for those types of releases, but they
all refer back to the common documentation:



Mime
View raw message