src/site/apt/examples/include-announcement-file.apt.vm

 ------
 Include an Announcement File in Your Packaging
 ------
 Dennis Lundberg
 ------
 2011-01-01
 ------

 ~~ 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.

 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/doxia/references/apt-format.html


Include an Announcement File in Your Packaging

  Since version 2.4 this plugin has options that allows you to put the generated
  announcement file anywhere you like. This makes it possible to include the
  generated announcement in your packaging.

* Configuring the Plugin

  In this example we want to call the generated announcement file
  <<<CHANGES.txt>>> and have it put into the <<<META-INF>>> directory of the
  project's JAR file. To do this we configure the Changes Plugin like this:

+-----------------+
<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>${project.version}</version>
        <executions>
          <execution>
            <id>include-announcement-file</id>
            <phase>generate-resources</phase>
            <goals>
              <goal>announcement-generate</goal>
            </goals>
            <configuration>
              <announcementFile>CHANGES.txt</announcementFile>
              <outputDirectory>\${project.build.outputDirectory}/META-INF</outputDirectory>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>
+-----------------+