maven-plugins/jira/xdocs/properties.xml
carlos 2134c137ab Authentication support for access a private Jira instalation. MPJIRA-8
Enable retrieving component-specific issues. MPJIRA-11
MPJIRA-13

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@232355 13f79535-47bb-0310-9956-ffa450edef68
2005-08-12 18:57:49 +00:00

171 lines
5.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.<br/>
</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.<br/>
</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>
</table>
</section>
</body>
</document>