<?xml version="1.0"?>
<!-- 
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 * 
 * Licensed 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.
 */
 -->

<document>

  <properties>
    <title>Maven Announcement plugin</title>
    <author email="vmassol@apache.org">Vincent Massol</author>
  </properties>

  <body>
    <section name="Maven Announcement plugin">
      <p>
        Generates release announcements. It takes information from the
        POM and from the <code>changes.xml</code> file and using a template 
        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>
