From 962e0c4076b4e54a622847bd14e95491d9fc14b0 Mon Sep 17 00:00:00 2001
From: vmassol <vmassol@13f79535-47bb-0310-9956-ffa450edef68>
Date: Fri, 2 Jul 2004 20:57:16 +0000
Subject: [PATCH] - Added new <code>announcement:generate-all</code> to
 generate announcement files for all releases. - Generates the announcement
 file in <code>${maven.gen.docs}/announcements</code> so that it is copied to
 the web site when this later is deployed. - Default announcement file name
 now contains the version in its name.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115627 13f79535-47bb-0310-9956-ffa450edef68
---
 announcement/plugin.jelly                     | 85 +++++++++++++++----
 announcement/plugin.properties                |  3 -
 .../src/plugin-resources/announcement.jsl     |  2 +-
 announcement/xdocs/changes.xml                | 11 +++
 announcement/xdocs/goals.xml                  | 10 ++-
 announcement/xdocs/properties.xml             |  2 +-
 6 files changed, 89 insertions(+), 24 deletions(-)

diff --git a/announcement/plugin.jelly b/announcement/plugin.jelly
index 177e721e..b4ad0ed8 100644
--- a/announcement/plugin.jelly
+++ b/announcement/plugin.jelly
@@ -26,25 +26,35 @@
   xmlns:util="jelly:util"
   xmlns:doc="doc"
   xmlns:maven="jelly:maven"
-  xmlns:jsl="jelly:jsl">
+  xmlns:jsl="jelly:jsl"
+  xmlns:announcement="announcement">
 
   <goal name="announcement" prereqs="announcement:generate"
     description="Generate release announcement"/>
 
-  <goal name="announcement:generate"
-    description="Generate release announcement">
+  <goal name="announcement:init">
 
-    <echo>Generating announcement for release ${maven.announcement.version} in ${maven.announcement.file}...</echo>
-
-    <util:file var="inputFile" name="${maven.docs.src}/changes.xml"/>
-    <x:parse var="doc" xml="${inputFile}"/>
-    
     <maven:property var="versionVariable" name="maven.announcement.version" 
         defaultValue="${pom.currentVersion}"/>
 
+    <maven:property var="announcementFile" name="maven.announcement.file" 
+        defaultValue="${maven.gen.docs}/announcements/announcement-${versionVariable}.txt"/>
+
+    <!-- Ensure the directory where the announcement will be created exists -->
+    <ant:dirname property="announcementDir" file="${announcementFile}"/>
+    <ant:mkdir dir="${announcementDir}"/>
+
+    <util:file var="inputFile" name="${maven.docs.src}/changes.xml"/>
+
     <maven:property var="distributionUrl" name="maven.announcement.distributionUrl" 
         defaultValue="${maven.repo.remote}/${pom.groupId}/plugins"/>
-  
+
+  </goal>
+
+  <goal name="announcement:check-version" prereqs="announcement:init">
+    
+    <x:parse var="doc" xml="${inputFile}"/>
+
     <jsl:stylesheet select="$doc">
       <jsl:template match="document/body/release">
         <x:set var="version" select="string(@version)"/>
@@ -52,22 +62,61 @@
             <x:set var="versionFound" select="string(@version)"/>
         </j:if>
       </jsl:template>
+      <jsl:template match="@*"/>
+      <jsl:template match="text()"/>
     </jsl:stylesheet>
     
     <j:if test="${versionFound == null}">
       <ant:fail>The release '${maven.announcement.version}' could not be found in change log</ant:fail>
     </j:if>
     
-    <j:set var="stylesheetURI" 
-        value="file:${plugin.resources}/announcement.jsl"/>
-    <j:file
-        name="${maven.announcement.file}"
-        outputMode="xml"
-        omitXmlDeclaration="true"
-        prettyPrint="false">
-      <j:include uri="${stylesheetURI.toString()}"/>
-    </j:file>
+  </goal>
+
+  <goal name="announcement:generate" prereqs="announcement:check-version"
+    description="Generate release announcement">
+
+    <announcement:generate file="${announcementFile}"/>
 
   </goal>
 
+  <goal name="announcement:generate-all" prereqs="announcement:init"
+    description="Generate release announcement for all releases">
+
+    <x:parse var="doc" xml="${inputFile}"/>
+
+    <jsl:stylesheet select="$doc">
+      <jsl:template match="document/body/release">
+        <x:set var="versionVariable" select="string(@version)"/>
+        <j:set var="announcementFile" 
+            value="${maven.gen.docs}/announcements/announcement-${versionVariable}.txt"/>
+        <announcement:generate file="${announcementFile}"/>
+      </jsl:template>
+      <jsl:template match="@*"/>
+      <jsl:template match="text()"/>
+    </jsl:stylesheet>
+    
+  </goal>
+
+  <!-- Define common jelly script used by different goals as a jelly tag -->
+  <define:taglib uri="announcement">
+    <define:tag name="generate">
+      <!-- @file: Announcement file location -->
+      <!-- @versionVariable: version for which to generate the announcement -->
+
+      <echo>Generating announcement for release ${versionVariable} in ${file}...</echo>
+    
+      <j:set var="stylesheetURI" 
+          value="file:${plugin.resources}/announcement.jsl"/>
+
+      <j:file
+          name="${file}"
+          outputMode="xml"
+          omitXmlDeclaration="true"
+          prettyPrint="false">
+        <j:include uri="${stylesheetURI.toString()}"/>
+      </j:file>
+
+    </define:tag>
+  </define:taglib>
+
 </project>
diff --git a/announcement/plugin.properties b/announcement/plugin.properties
index 7ba58565..fa1de96d 100644
--- a/announcement/plugin.properties
+++ b/announcement/plugin.properties
@@ -23,9 +23,6 @@
 # For example:
 # maven.announcement.version = ${pom.currentVersion}
 
-# Name and location of generated announcement file
-maven.announcement.file=${maven.build.dir}/announcement.txt
-
 # Distribution location. For now, this property does not exist in the
 # POM (there's only a distributionSite and distributionDirectory which
 # doesn't map to anything for the web). We'll need to remove this
diff --git a/announcement/src/plugin-resources/announcement.jsl b/announcement/src/plugin-resources/announcement.jsl
index fb9c15c5..6b461c80 100644
--- a/announcement/src/plugin-resources/announcement.jsl
+++ b/announcement/src/plugin-resources/announcement.jsl
@@ -29,10 +29,10 @@
     xmlns:maven="jelly:maven"
     xmlns="dummy" trim="true">
 
+  <!-- This stylesheet expects the versionVariable to be defined before calling it -->
   <jsl:template match="document/body/release">
 
     <x:set var="version" select="string(@version)"/>
-    <maven:property var="versionVariable" name="maven.announcement.version" defaultValue="${pom.currentVersion}"/>
     <j:if test="${versionVariable.equals(version)}">
 
       <j:useBean var="formatter" class="org.apache.maven.announcement.Formatter"/>
diff --git a/announcement/xdocs/changes.xml b/announcement/xdocs/changes.xml
index 3a52dd3f..c82dbf65 100644
--- a/announcement/xdocs/changes.xml
+++ b/announcement/xdocs/changes.xml
@@ -25,6 +25,17 @@
   </properties>
   <body>
     <release version="1.2-SNAPSHOT" date="in CVS">
+      <action dev="vmassol" type="add">
+        Added new <code>announcement:generate-all</code> to generate 
+        announcement files for all releases.
+      </action>
+      <action dev="vmassol" type="update">
+        Generates the announcement file in <code>${maven.gen.docs}/announcements</code>
+        so that it is copied to the web site when this later is deployed.
+      </action>
+      <action dev="vmassol" type="update">
+        Default announcement file name now contains the version in its name.
+      </action>
     </release>
     <release version="1.1" date="2004-05-15">
       <action dev="brett" type="update">Detect whether the project is a plugin or not by the existence of plugin.jelly in the project directory, and change the wording accordingly.</action>
diff --git a/announcement/xdocs/goals.xml b/announcement/xdocs/goals.xml
index 5e085241..5b78dbc1 100644
--- a/announcement/xdocs/goals.xml
+++ b/announcement/xdocs/goals.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+
 <!-- 
 /*
  * Copyright 2001-2004 The Apache Software Foundation.
@@ -37,7 +38,14 @@
         <tr>
           <td>announcement:generate</td>
           <td>
-            Generate text release announcement.
+            Generate a release announcement in text format
+          </td>
+        </tr>
+        <tr>
+          <td>announcement:generate-all</td>
+          <td>
+            Generate a release announcement in text format for all releases 
+            found in <code>changes.xml</code>
           </td>
         </tr>
       </table>
diff --git a/announcement/xdocs/properties.xml b/announcement/xdocs/properties.xml
index 93fcdae5..f42ca4e0 100644
--- a/announcement/xdocs/properties.xml
+++ b/announcement/xdocs/properties.xml
@@ -45,7 +45,7 @@
             The file name that the announcement is generated into.
           </td>
           <td>
-            <code>${maven.build.dir}/announcement.txt</code>
+            <code>${maven.gen.docs}/announcements/announcement-${versionVariable}.txt</code>
           </td>
         </tr>
         <tr>