8ea14ba594
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@368519 13f79535-47bb-0310-9956-ffa450edef68
85 lines
3.9 KiB
XML
85 lines
3.9 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.
|
|
*/
|
|
-->
|
|
|
|
<faqs title="Frequently Asked Questions">
|
|
|
|
<part id="general">
|
|
<title>General</title>
|
|
|
|
<faq id="how-use-it">
|
|
<question>
|
|
How to use this plugin?
|
|
</question>
|
|
<answer>
|
|
<p>
|
|
1. The jira plugin needs the jira id number of your project to work. Preferably,
|
|
your project.xml should have an <code><issueTrackingUrl></code> in the following format :
|
|
</p>
|
|
<source><issueTrackingUrl>[JIRA URL]/BrowseProject.jspa?id=[JIRA PROJECT ID]</issueTrackingUrl></source>
|
|
<p>Example :</p>
|
|
<source><issueTrackingUrl>http://jira.codehaus.org/secure/BrowseProject.jspa?id=10450</issueTrackingUrl></source>
|
|
<p>
|
|
If no id is found in <code><issueTrackingUrl></code>, like eg, in
|
|
</p>
|
|
<source><issueTrackingUrl>http://jira.codehaus.org/browse/MPJIRA</issueTrackingUrl></source>
|
|
<p>
|
|
an attempt is made to extract the id from the jira project page, but this is not guaranteed to work.
|
|
</p>
|
|
<p>
|
|
2. Determine the credentials to log into the webserver, if any. The plugin supports basic authentication (and SSL).
|
|
Add the credentials to the project.properties, as maven.jira.webUser and maven.jira.webPassword
|
|
</p>
|
|
<p>
|
|
3. Determine the JIRA account to login to the JIRA installation.
|
|
Add the credentials to the project.properties, as maven.jira.jiraUser and maven.jira.jiraPassword
|
|
</p>
|
|
<p>
|
|
4. log out of jira (if you are using Remember me feature) and test your setup
|
|
by going to url like this one:
|
|
</p>
|
|
<source>[JIRA URL]/secure/IssueNavigator.jspa?view=rss&pid=[JIRA PROJECT ID]&sorter/field=issuekey&sorter/order=DESC&sorter/field=status&sorter/order=DESC&tempMax=1000&reset=true</source>
|
|
<p>Example :</p>
|
|
<source>http://jira.codehaus.org/secure/IssueNavigator.jspa?view=rss&pid=10450&sorter/field=issuekey&sorter/order=DESC&sorter/field=status&sorter/order=DESC&tempMax=1000&reset=true</source>
|
|
|
|
<p>
|
|
5. add this to your project.xml in reports section
|
|
</p>
|
|
<source><report>maven-jira-plugin</report></source>
|
|
<p>
|
|
6. run maven site (or just maven maven-jira-plugin:report xdoc) and you should have jira.html in your ${basedir}/target/docs directory
|
|
</p>
|
|
</answer>
|
|
</faq>
|
|
<faq id="untrusted cert">
|
|
<question>
|
|
My JIRA installation runs SSL with a self signed/home brewn certificate.
|
|
I get an error message that the certificate is untrusted. How do I proceed?
|
|
</question>
|
|
<answer>
|
|
<p>
|
|
Add the server certificate to your JAVA. You can get the certificate by exporting it from your browser.
|
|
With IE you click on the certificate info, go to the details TAB and export as .DER by clicking on 'Copy to File...'.
|
|
Using SUN's keytool you can import the certificate in your 'truststore'. It is located in $JAVA_HOME/jre/lib/security/cacerts
|
|
Import it using <source>keytool -import -file <servercert>.cer -keystore cacerts</source>
|
|
</p>
|
|
</answer>
|
|
</faq>
|
|
</part>
|
|
</faqs>
|