maven-plugins/jira/xdocs/properties.xml
ltheussl 9085bf2e19 PR: MPJIRA-10
Jira plugin does not work with NTLM proxy.


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@373582 13f79535-47bb-0310-9956-ffa450edef68
2006-01-30 20:44:09 +00:00

205 lines
6.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* 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 JIRA Plug-in Properties</title>
</properties>
<body>
<section name="Maven JIRA Plug-in Settings">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
<th>Default value</th>
</tr>
<tr>
<td>maven.jira.nbentries</td>
<td>Yes</td>
<td>
<p>
Defines the maximum number of issues we want to obtain into the report.
</p>
</td>
<td>
<p>
<code>1000</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jira.component</td>
<td>Yes</td>
<td>
<p>
Sets the component(s) of the project you want to limit your report to.
Multiple components can be separated by commas (such as <code>10011,10012</code>).
</p>
</td>
<td>
<p>
empty, meaning all components.
</p>
</td>
</tr>
<tr>
<td>maven.jira.status</td>
<td>Yes</td>
<td>
<p>
Sets the status(es) of the project you want to limit your report to.
Valid statuses are: <code>Open, In Progress, Reopened, Resolved and Closed</code>.
Multiple values can be separated by commas.
</p>
</td>
<td>
<p>
<code>Open, In Progress, Reopened</code>
</p>
</td>
</tr>
<tr>
<td>maven.jira.resolution</td>
<td>Yes</td>
<td>
<p>
Sets the resolution(s) of the project you want to limit your report to.
Valid statuses are: <code>Unresolved, Fixed, Won't Fix, Duplicate, Incomplete, Cannot Reproduce</code>.
Multiple values can be separated by commas.
</p>
</td>
<td>
<p>
<code>Unresolved</code>
</p>
</td>
</tr>
<tr>
<td>maven.jira.priority</td>
<td>Yes</td>
<td>
<p>
Sets the priority(s) of the project you want to limit your report to.
Valid statuses are: <code>Blocker, Critical, Major, Minor, Trivial</code>.
Multiple values can be separated by commas.
</p>
</td>
<td>
<p>
empty, meaning any priority.
</p>
</td>
</tr>
<tr>
<td>maven.jira.filter</td>
<td>Yes</td>
<td>
<p>
Defines the filter parameters to restrict the result issues from Jira.
The filter parameters property must use the same format of url parameters from the Jira search url.
Example: <code>status=1&amp;resolution=-1&amp;priority=1&amp;priority=3&amp;priority=4&amp;sorter/field=issuekey&amp;sorter/order=DESC</code>
</p>
<p>
<b>Note</b>: This string should not contain the parameters <code>pid</code>, <code>tempMax</code>
and <code>view</code>.<br/>
<b>Note</b>: This filter overrides the status, resolution, priority and component properties.
</p>
</td>
<td></td>
</tr>
<tr>
<td>maven.jira.jiraUser</td>
<td>Yes</td>
<td>
<p>
Defines the jira username for authentication into a private Jira instalation.
</p>
</td>
<td></td>
</tr>
<tr>
<td>maven.jira.jiraPassword</td>
<td>Yes</td>
<td>
<p>
Defines the jira password for authentication into a private Jira instalation.
</p>
</td>
<td></td>
</tr>
<tr>
<td>maven.jira.webUser</td>
<td>Yes</td>
<td>
<p>
Defines the http user for basic authentication into the Jira webserver.
</p>
</td>
<td></td>
</tr>
<tr>
<td>maven.jira.webPassword</td>
<td>Yes</td>
<td>
<p>
Defines the http password for basic authentication into the Jira webserver.
</p>
</td>
<td></td>
</tr>
<tr>
<td>maven.jira.proxy.ntlm.host</td>
<td>Yes</td>
<td>
<p>
The host to use if you are using NTLM authentication
</p>
</td>
<td><code>${maven.proxy.ntlm.host}</code></td>
</tr>
<tr>
<td>maven.jira.proxy.ntlm.domain</td>
<td>Yes</td>
<td>
<p>
The NT domain to use if you are using NTLM authentication.
</p>
</td>
<td><code>${maven.proxy.ntlm.domain}</code></td>
</tr>
<tr>
<td>maven.jira.roadmap</td>
<td>Yes</td>
<td>
<p>
If set to <code>true</code>, a report on issues in the Jira
roadmap is generated. This includes issues
that are fixed in the current development version and issues
that are scheduled to be fixed in the next release.
</p>
</td>
<td><p><code>true</code></p></td>
</tr>
</table>
</section>
</body>
</document>