You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2007/08/02 22:24:23 UTC

svn commit: r562239 - in /maven/plugins/trunk/maven-changes-plugin/src: main/java/org/apache/maven/plugin/changes/ChangesMojo.java site/apt/usage.apt

Author: dennisl
Date: Thu Aug  2 13:24:22 2007
New Revision: 562239

URL: http://svn.apache.org/viewvc?view=rev&rev=562239
Log:
[MCHANGES-82] Issue Management URL not ending in a '/' result in an incorrect issue link on the change report.

o Update the documentation to explain why this problem might occur. The issue itself will not be fixed.

Modified:
    maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java
    maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt

Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java?view=diff&rev=562239&r1=562238&r2=562239
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java Thu Aug  2 13:24:22 2007
@@ -75,8 +75,8 @@
     /**
      * Template string that is used to discover the URL to use to display an issue report.
      * There are 2 template tokens you can use. %URL%: this is computed by getting the
-     * <issueManagement><url> value from the POM, and removing the context path. %ISSUE% :
-     * this is the issue number.
+     * <issueManagement>/<url> value from the POM, and removing the last '/'
+     * and everything that comes after it. %ISSUE% : this is the issue number.
      * <p>
      * <strong>Note:</strong> In versions of this plugin prior to 2.0-beta-2 this parameter was called
      * <code>link_template</code>.

Modified: maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt?view=diff&rev=562239&r1=562238&r2=562239
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt Thu Aug  2 13:24:22 2007
@@ -126,6 +126,23 @@
 mvn site
 -------------------
 
+** Linking to Your Issue Management System
+
+  If you use the <<<issue>>> attribute in your <<<changes.xml>>> file and have
+  the <<<\<issueManagement\>>>> element configured in your <<<pom.xml>>>, the
+  report will contain links to the issues in your issue management system. The
+  default configuration produces links to JIRA, but that can be
+  {{{changes-report-mojo.html}configured}}.
+
+  <<Note:>> If you have
+  another issue tracker, make sure that your <<<\<issueManagement\>/\<url\>>>> is
+  correct. In particular, make sure that it has a trailing slash if it needs one.
+  The plugin can't add this for you, because it needs to handle different issue
+  management systems. If your issue management system is at
+  <<<http://www.company.com/bugzilla/>>>
+  the links will not work if you enter <<<http://www.company.com/bugzilla>>>
+  in your <<<pom.xml>>>.
+
 
 *How to Generate the JIRA Report