maven-plugins/announcement/xdocs/properties.xml

<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- 
/*
 * 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.
 */
 -->

<document>

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

  <body>
    <section name="Announcement plugin properties">
      <table>
        <tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
        <tr>
          <td>maven.announcement.version</td>
          <td>Yes</td>
          <td>
            Version for which to create a release note.       	
          </td>
          <td>
            <code>${pom.currentVersion}</code>
          </td>
        </tr>
        <tr>
          <td>maven.announcement.file</td>
          <td>Yes</td>
          <td>
            The file name that the announcement is generated into.
          </td>
          <td>
            <code>${maven.gen.docs}/announcements/announcement-${versionVariable}.txt</code>
          </td>
        </tr>
        <tr>
          <td>maven.announcement.repo.remote</td>
          <td>Yes</td>
          <td>
            Specify from which Maven remote repository the artifact for this 
            project can be found. For now, this property does not exist in 
            the POM (there's only a distributionSite and distributionDirectory 
            which don't map to anything for the web). We'll need to remove this
            property once it makes it into the POM.
          </td>
          <td>
            <code>${maven.repo.remote}</code>
          </td>
        </tr>
        <tr>
          <td>maven.announcement.distributionUrl</td>
          <td>Yes</td>
          <td>
            Distribution location.
          </td>
          <td>
            <code>${maven.announcement.repo.remote}/${pom.groupId}/plugins</code>
          </td>
        </tr>
        <tr>
          <td>maven.announcement.stylesheet.path</td>
          <td>Yes</td>
          <td>
            Stylesheet to use to generate the text announcement.
          </td>
          <td>
            <code>${plugin.resources}/announcement.jsl</code>
          </td>
        </tr>
        <tr>
          <td>maven.announcement.mail.server</td>
          <td>Required for announcement:mail goal</td>
          <td>
            Address of the SMTP server used to send the email message.
          </td>
          <td>none
          </td>
        </tr>
        <tr>
          <td>maven.announcement.mail.client</td>
          <td>Yes</td>
          <td>
            Name of the host/domain used to log on the SMTP server.
          </td>
          <td>localhost
          </td>
        </tr>
        <tr>
          <td>maven.announcement.mail.subject</td>
          <td>Yes</td>
          <td>
            Subject of the announcement email message.
          </td>
          <td>
            <code>[ANN] ${pom.name} %VERSION% released</code>
          </td>
        </tr>
        <tr>
          <td>maven.announcement.mail.from</td>
          <td>Yes</td>
          <td>
            Sender (email address) of the announcement message.
          </td>
          <td>
            First developer email found in the POM
          </td>
        </tr>
        <tr>
          <td>maven.announcement.mail.to</td>
          <td>Required for announcement:mail goal</td>
          <td>
            Comma-separated list of To: address used as recipients of the announcement message.
          </td>
          <td>none
          </td>
        </tr>
        <tr>
          <td>maven.announcement.encoding</td>
          <td>Yes</td>
          <td>
            Encoding used to generate the announcement file.
          </td>
          <td>
            <code>UTF-8</code>
          </td>
        </tr>
        <tr>
          <td>maven.announcement.lenient</td>
          <td>Yes</td>
          <td>
            When set to <code>false</code>, the plugin will fail in the occurrence of any of the following conditions:<br/>
            <ul>
              <li><code>xdocs/changes.xml</code> file is not available</li>
              <li><code>xdocs/changes.xml</code> has not a <code>release</code> entry for the current version</li>
              <li><code>project.xml</code> has not a <code>version</code> entry for the current version</li>
            </ul>
          </td>
          <td>
            <code>false</code>
          </td>
        </tr>
      </table>
    </section>
  </body>
</document>