You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by vm...@apache.org on 2004/05/01 19:53:24 UTC
cvs commit: maven-plugins/announcement/xdocs changes.xml goals.xml index.xml
vmassol 2004/05/01 10:53:24
Modified: announcement/xdocs changes.xml goals.xml index.xml
Log:
improved website documentation
Revision Changes Path
1.12 +3 -0 maven-plugins/announcement/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/maven-plugins/announcement/xdocs/changes.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- changes.xml 1 May 2004 17:45:53 -0000 1.11
+++ changes.xml 1 May 2004 17:53:24 -0000 1.12
@@ -25,6 +25,9 @@
</properties>
<body>
<release version="1.1" date="in CVS">
+ <action dev="vmassol" type="add">
+ Improved web site documentation.
+ </action>
<action dev="vmassol" type="fix">
Add a space after the "." of the "Fixes xxx." (which happens when
you use the "issue" attribute in changes.xml).
1.3 +7 -1 maven-plugins/announcement/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/maven-plugins/announcement/xdocs/goals.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- goals.xml 4 Mar 2004 17:58:48 -0000 1.2
+++ goals.xml 1 May 2004 17:53:24 -0000 1.3
@@ -29,7 +29,13 @@
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
- <td>announcement:text</td>
+ <td>announcement</td>
+ <td>
+ Default goal. Does the same as <code>announcement:generate</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>announcement:generate</td>
<td>
Generate text release announcement.
</td>
1.3 +60 -0 maven-plugins/announcement/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/announcement/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 4 Mar 2004 17:58:48 -0000 1.2
+++ index.xml 1 May 2004 17:53:24 -0000 1.3
@@ -32,5 +32,65 @@
generates release information.
</p>
</section>
+ <section name="Example">
+ <p>
+ Here is a sample announcement:
+ </p>
+<source><![CDATA[
+The maven team is pleased to announce the Maven Announcement plugin 1.1
+release!
+
+http://maven.apache.org/reference/plugins/announcement/
+
+The Announcement plugin generates release announcements. It uses the
+information found in both the POM and in the changes.xml file to generate the
+announcement text.
+
+Changes in this version include:
+
+ New Features:
+
+o Added description information from the POM to the generated announcement to
+ explain what the project does.
+o Added information in the generated announcement to indicate from where the
+ plugin can be downloaded.
+o Added information in the generated announcement to indicate how to install
+ the plugin using the plugin:download goal.
+o Added more information when running the plugin. Also added a check to
+ verify if the announcement version matches an entry in the changes.xml
+ file. Fixes MPANNOUNCEMENT-2. Thanks to Fabrizio Giustina.
+o Several new additions that makes the plugin more generic: the team name is
+ now taken from pom.groupId, "[]" are removed from the first line, changes
+ are sorted by type, changes report issue number and due-to, the download
+ link is generated from pom.distributionDirectory and the "plugin has been
+ tested with..." line has been removed. Fixes MPANNOUNCEMENT-1. Thanks to
+ Fabrizio Giustina.
+
+ Fixed bugs:
+
+o Add a space after the "." of the "Fixes xxx." (which happens when you use
+ the "issue" attribute in changes.xml).
+
+ Changes:
+
+o Added maven.announcement.file property and echo'd it during generation
+
+To automatically install the plugin, type the following on a single line:
+
+maven plugin:download
+ -DgroupId=maven
+ -DartifactId=maven-announcement-plugin
+ -Dversion=1.1
+
+For a manual installation, you can download the Maven Announcement plugin
+here:
+
+http://www.ibiblio.org/maven/maven/plugins/maven-announcement-plugin-1.1.jar
+
+Have fun!
+-The development team
+]]></source>
+ </section>
</body>
+
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org