maven-plugins/changes/xdocs/properties.xml
ltheussl 137cb3f9dd PR: MPCHANGES-32
The encoding of the changes.xml file is not preserved after doing release-version.
New property maven.changes.outputencoding.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@434555 13f79535-47bb-0310-9956-ffa450edef68
2006-08-24 22:55:52 +00:00

96 lines
3.0 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* 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>Changes plugin properties</title>
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<section name="Changes plugin properties">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>maven.changes.issue.template</td>
<td>Yes</td>
<td>
Template string that is used to discover the URL to use to display
a bug report. There are 2 template tokens you can use.
<code>%URL%</code>: this is computed by getting the
<code>&lt;issueTrackingUrl&gt;</code> value from the POM, and
removing the context path. <code>%ISSUE%</code> : this is the issue
number.
</td>
<td>
<code>%URL%/%ISSUE%</code> (Default, appropriate for JIRA).
<br/>
Other possibilities are:
<br/>
SourceForge: <code>http://sourceforge.net/support/tracker.php?aid=%ISSUE%</code>
<br/>
BugZilla: <code>%URL%/show_bug.cgi?id=%ISSUE%</code>
<br/>
Scarab: <code>%URL%/issues/id/%ISSUE%</code>
<br/>
Mantis: <code>%URL%/view.php?id=%ISSUE%</code>
</td>
</tr>
<tr>
<td>maven.changes.sort</td>
<td>Yes</td>
<td>
Decides whether to enable sorting the <code>&lt;action&gt;</code>
elements or not.
</td>
<td>
false
</td>
</tr>
<tr>
<td>maven.changes.sort.order</td>
<td>Yes</td>
<td>
Decides sort ordering of <code>&lt;action&gt;</code> elements.
It is only used if sorting is enabled.
</td>
<td>
add,fix,update,remove
</td>
</tr>
<tr>
<td>maven.changes.outputencoding</td>
<td>Yes</td>
<td>
Sets the encoding for the changes.xml file when using
the release-version tag. This can be useful to ensure
the same encoding for all files.
</td>
<td>
Default is empty, so the encoding of changes.xml will be preserved.
</td>
</tr>
</table>
</section>
</body>
</document>