This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch MCHANGES-453
in repository https://gitbox.apache.org/repos/asf/maven-changes-plugin.git
commit 59b2216e88486bb28b663fe283f72740db144e66
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Tue Dec 3 22:51:37 2024 +0100
[MCHANGES-453] Align report output and goals names
---
src/it/report-github/verify.groovy | 2 +-
src/it/report-jira/verify.groovy | 2 +-
.../maven/plugins/changes/ChangesReport.java | 6 ++--
.../plugins/changes/ChangesReportDeprecated.java} | 27 ++++++++++++------
.../maven/plugins/changes/github/GitHubReport.java | 4 +--
.../changes/github/GitHubReportDeprecated.java} | 27 ++++++++++++------
.../maven/plugins/changes/jira/JiraReport.java | 6 ++--
.../changes/jira/JiraReportDeprecated.java} | 28 +++++++++++++------
.../maven/plugins/changes/trac/TracReport.java | 4 +--
.../changes/trac/TracReportDeprecated.java} | 23 ++++++++--------
.../examples/alternate-changes-xml-location.apt.vm | 2 +-
.../apt/examples/configuring-github-report.apt.vm | 2 +-
.../apt/examples/configuring-trac-report.apt.vm | 4 +--
.../apt/examples/customizing-jira-report.apt.vm | 4 +--
src/site/apt/index.apt.vm | 32 ++++++++++++++++------
src/site/apt/usage.apt.vm | 8 +++---
src/site/site.xml | 2 +-
.../plugins/changes/jira/JiraUnicodeTestCase.java | 2 +-
18 files changed, 115 insertions(+), 70 deletions(-)
diff --git a/src/it/report-github/verify.groovy
b/src/it/report-github/verify.groovy
index b316f81..b2e07f1 100644
--- a/src/it/report-github/verify.groovy
+++ b/src/it/report-github/verify.groovy
@@ -22,7 +22,7 @@ import com.github.tomakehurst.wiremock.WireMockServer
WireMockServer wireMockServer = context.get("wireMockServer")
wireMockServer.stop()
-content = new File(basedir, 'target/site/github-report.html').text;
+content = new File(basedir, 'target/site/github.html').text;
assert content.contains('/owner-name/repo-name/issues/1234">1234</a>');
assert content.contains('<td>Authentication does not work after Upgrade</td>');
diff --git a/src/it/report-jira/verify.groovy b/src/it/report-jira/verify.groovy
index a80f3ce..de20f66 100644
--- a/src/it/report-jira/verify.groovy
+++ b/src/it/report-jira/verify.groovy
@@ -22,7 +22,7 @@ import com.github.tomakehurst.wiremock.WireMockServer
WireMockServer wireMockServer = context.get("wireMockServer")
wireMockServer.stop()
-content = new File(basedir, 'target/site/jira-report.html').text;
+content = new File(basedir, 'target/site/jira.html').text;
assert content.contains('/browse/TEST_PROJECT-1">TEST_PROJECT-1</a>');
assert content.contains('<td>Authentication does not work after Upgrade</td>');
diff --git a/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java
b/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java
index 8fe4f33..ba98d6b 100644
--- a/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java
+++ b/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java
@@ -53,9 +53,9 @@ import org.codehaus.plexus.util.FileUtils;
* Goal which creates a nicely formatted Changes Report in html format from a
changes.xml file.
*
* @author <a href="mailto:jr...@exist.com";>Johnny R. Ruiz III</a>
- * @version $Id$
+ * @since 2.0
*/
-@Mojo(name = "changes-report", threadSafe = true)
+@Mojo(name = "changes", threadSafe = true)
public class ChangesReport extends AbstractChangesReport {
/**
* A flag whether the report should also include changes from child
modules. If set to <code>false</code>, only the
@@ -299,7 +299,7 @@ public class ChangesReport extends AbstractChangesReport {
@Override
@Deprecated
public String getOutputName() {
- return "changes-report";
+ return "changes";
}
/* --------------------------------------------------------------------- */
diff --git a/src/it/report-jira/verify.groovy
b/src/main/java/org/apache/maven/plugins/changes/ChangesReportDeprecated.java
similarity index 56%
copy from src/it/report-jira/verify.groovy
copy to
src/main/java/org/apache/maven/plugins/changes/ChangesReportDeprecated.java
index a80f3ce..d8f4e1c 100644
--- a/src/it/report-jira/verify.groovy
+++
b/src/main/java/org/apache/maven/plugins/changes/ChangesReportDeprecated.java
@@ -16,16 +16,25 @@
* specific language governing permissions and limitations
* under the License.
*/
+package org.apache.maven.plugins.changes;
-import com.github.tomakehurst.wiremock.WireMockServer
+import javax.inject.Inject;
-WireMockServer wireMockServer = context.get("wireMockServer")
-wireMockServer.stop()
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.shared.filtering.MavenFileFilter;
-content = new File(basedir, 'target/site/jira-report.html').text;
+/**
+ * Goal which creates a nicely formatted Changes Report in html format from a
changes.xml file.
+ *
+ * @author <a href="mailto:jr...@exist.com";>Johnny R. Ruiz III</a>
+ * @deprecated use {@code change} goal
+ */
+@Deprecated
+@Mojo(name = "changes-report", threadSafe = true)
+public class ChangesReportDeprecated extends ChangesReport {
-assert content.contains('/browse/TEST_PROJECT-1">TEST_PROJECT-1</a>');
-assert content.contains('<td>Authentication does not work after Upgrade</td>');
-assert content.contains('<td>Closed</td>');
-assert content.contains('<td>Fixed</td>');
-assert content.contains('<td>Assigned User</td>');
+ @Inject
+ public ChangesReportDeprecated(MavenFileFilter mavenFileFilter) {
+ super(mavenFileFilter);
+ }
+}
diff --git
a/src/main/java/org/apache/maven/plugins/changes/github/GitHubReport.java
b/src/main/java/org/apache/maven/plugins/changes/github/GitHubReport.java
index 23b5d69..34767b8 100644
--- a/src/main/java/org/apache/maven/plugins/changes/github/GitHubReport.java
+++ b/src/main/java/org/apache/maven/plugins/changes/github/GitHubReport.java
@@ -45,7 +45,7 @@ import org.apache.maven.settings.crypto.SettingsDecrypter;
* @author Bryan Baugher
* @since 2.8
*/
-@Mojo(name = "github-report", threadSafe = true)
+@Mojo(name = "github", threadSafe = true)
public class GitHubReport extends AbstractChangesReport {
/**
@@ -129,7 +129,7 @@ public class GitHubReport extends AbstractChangesReport {
@Override
@Deprecated
public String getOutputName() {
- return "github-report";
+ return "github";
}
@Override
diff --git a/src/it/report-jira/verify.groovy
b/src/main/java/org/apache/maven/plugins/changes/github/GitHubReportDeprecated.java
similarity index 59%
copy from src/it/report-jira/verify.groovy
copy to
src/main/java/org/apache/maven/plugins/changes/github/GitHubReportDeprecated.java
index a80f3ce..88ba5ab 100644
--- a/src/it/report-jira/verify.groovy
+++
b/src/main/java/org/apache/maven/plugins/changes/github/GitHubReportDeprecated.java
@@ -16,16 +16,25 @@
* specific language governing permissions and limitations
* under the License.
*/
+package org.apache.maven.plugins.changes.github;
-import com.github.tomakehurst.wiremock.WireMockServer
+import javax.inject.Inject;
-WireMockServer wireMockServer = context.get("wireMockServer")
-wireMockServer.stop()
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.settings.crypto.SettingsDecrypter;
-content = new File(basedir, 'target/site/jira-report.html').text;
+/**
+ * Goal which downloads issues from GitHub and generates a report.
+ *
+ * @since 2.8
+ * @deprecated use {@code github} goal
+ */
+@Deprecated
+@Mojo(name = "github-report", threadSafe = true)
+public class GitHubReportDeprecated extends GitHubReport {
-assert content.contains('/browse/TEST_PROJECT-1">TEST_PROJECT-1</a>');
-assert content.contains('<td>Authentication does not work after Upgrade</td>');
-assert content.contains('<td>Closed</td>');
-assert content.contains('<td>Fixed</td>');
-assert content.contains('<td>Assigned User</td>');
+ @Inject
+ public GitHubReportDeprecated(SettingsDecrypter settingsDecrypter) {
+ super(settingsDecrypter);
+ }
+}
diff --git
a/src/main/java/org/apache/maven/plugins/changes/jira/JiraReport.java
b/src/main/java/org/apache/maven/plugins/changes/jira/JiraReport.java
index 7b0ffe7..677f020 100644
--- a/src/main/java/org/apache/maven/plugins/changes/jira/JiraReport.java
+++ b/src/main/java/org/apache/maven/plugins/changes/jira/JiraReport.java
@@ -43,9 +43,9 @@ import org.apache.maven.settings.crypto.SettingsDecrypter;
* Goal which downloads issues from the Issue Tracking System and generates a
report.
*
* @author <a href="mailto:jr...@exist.com";>Johnny R. Ruiz III</a>
- * @version $Id$
+ * @since 2.0
*/
-@Mojo(name = "jira-report", threadSafe = true)
+@Mojo(name = "jira", threadSafe = true)
public class JiraReport extends AbstractChangesReport {
/**
* Valid JIRA columns.
@@ -375,7 +375,7 @@ public class JiraReport extends AbstractChangesReport {
@Override
@Deprecated
public String getOutputName() {
- return "jira-report";
+ return "jira";
}
/* --------------------------------------------------------------------- */
diff --git a/src/it/report-jira/verify.groovy
b/src/main/java/org/apache/maven/plugins/changes/jira/JiraReportDeprecated.java
similarity index 56%
copy from src/it/report-jira/verify.groovy
copy to
src/main/java/org/apache/maven/plugins/changes/jira/JiraReportDeprecated.java
index a80f3ce..12a0c4a 100644
--- a/src/it/report-jira/verify.groovy
+++
b/src/main/java/org/apache/maven/plugins/changes/jira/JiraReportDeprecated.java
@@ -16,16 +16,26 @@
* specific language governing permissions and limitations
* under the License.
*/
+package org.apache.maven.plugins.changes.jira;
-import com.github.tomakehurst.wiremock.WireMockServer
+import javax.inject.Inject;
-WireMockServer wireMockServer = context.get("wireMockServer")
-wireMockServer.stop()
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.settings.crypto.SettingsDecrypter;
-content = new File(basedir, 'target/site/jira-report.html').text;
+/**
+ * Goal which downloads issues from the Issue Tracking System and generates a
report.
+ *
+ * @author <a href="mailto:jr...@exist.com";>Johnny R. Ruiz III</a>
+ * @since 2.0
+ * @deprecated use {@code jira} goal
+ */
+@Deprecated
+@Mojo(name = "jira-report", threadSafe = true)
+public class JiraReportDeprecated extends JiraReport {
-assert content.contains('/browse/TEST_PROJECT-1">TEST_PROJECT-1</a>');
-assert content.contains('<td>Authentication does not work after Upgrade</td>');
-assert content.contains('<td>Closed</td>');
-assert content.contains('<td>Fixed</td>');
-assert content.contains('<td>Assigned User</td>');
+ @Inject
+ public JiraReportDeprecated(SettingsDecrypter settingsDecrypter) {
+ super(settingsDecrypter);
+ }
+}
diff --git
a/src/main/java/org/apache/maven/plugins/changes/trac/TracReport.java
b/src/main/java/org/apache/maven/plugins/changes/trac/TracReport.java
index c6eb120..9d71c32 100644
--- a/src/main/java/org/apache/maven/plugins/changes/trac/TracReport.java
+++ b/src/main/java/org/apache/maven/plugins/changes/trac/TracReport.java
@@ -42,7 +42,7 @@ import org.apache.xmlrpc.XmlRpcException;
* @version $Id$
* @since 2.1
*/
-@Mojo(name = "trac-report", threadSafe = true)
+@Mojo(name = "trac", threadSafe = true)
public class TracReport extends AbstractChangesReport {
/**
@@ -163,7 +163,7 @@ public class TracReport extends AbstractChangesReport {
@Override
@Deprecated
public String getOutputName() {
- return "trac-report";
+ return "trac";
}
/* --------------------------------------------------------------------- */
diff --git a/src/it/report-jira/verify.groovy
b/src/main/java/org/apache/maven/plugins/changes/trac/TracReportDeprecated.java
similarity index 62%
copy from src/it/report-jira/verify.groovy
copy to
src/main/java/org/apache/maven/plugins/changes/trac/TracReportDeprecated.java
index a80f3ce..a217a9d 100644
--- a/src/it/report-jira/verify.groovy
+++
b/src/main/java/org/apache/maven/plugins/changes/trac/TracReportDeprecated.java
@@ -16,16 +16,17 @@
* specific language governing permissions and limitations
* under the License.
*/
+package org.apache.maven.plugins.changes.trac;
-import com.github.tomakehurst.wiremock.WireMockServer
+import org.apache.maven.plugins.annotations.Mojo;
-WireMockServer wireMockServer = context.get("wireMockServer")
-wireMockServer.stop()
-
-content = new File(basedir, 'target/site/jira-report.html').text;
-
-assert content.contains('/browse/TEST_PROJECT-1">TEST_PROJECT-1</a>');
-assert content.contains('<td>Authentication does not work after Upgrade</td>');
-assert content.contains('<td>Closed</td>');
-assert content.contains('<td>Fixed</td>');
-assert content.contains('<td>Assigned User</td>');
+/**
+ * Goal which downloads issues from the Issue Tracking System and generates a
report.
+ *
+ * @author Noriko Kinugasa
+ * @version $Id$
+ * @since 2.1
+ * @deprecated use {@code track} goal
+ */
+@Mojo(name = "trac-report", threadSafe = true)
+public class TracReportDeprecated extends TracReport {}
diff --git a/src/site/apt/examples/alternate-changes-xml-location.apt.vm
b/src/site/apt/examples/alternate-changes-xml-location.apt.vm
index ecab60d..ba3e630 100644
--- a/src/site/apt/examples/alternate-changes-xml-location.apt.vm
+++ b/src/site/apt/examples/alternate-changes-xml-location.apt.vm
@@ -56,7 +56,7 @@ Alternate Location for the <<<changes.xml>>> File
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/site/apt/examples/configuring-github-report.apt.vm
b/src/site/apt/examples/configuring-github-report.apt.vm
index d3785bd..1ae8dd1 100644
--- a/src/site/apt/examples/configuring-github-report.apt.vm
+++ b/src/site/apt/examples/configuring-github-report.apt.vm
@@ -29,7 +29,7 @@
Configuring the GitHub Report
- <<Note:>> See the {{{../github-report-mojo.html}goal documentation}} for
+ <<Note:>> See the {{{../github-mojo.html}goal documentation}} for
detailed info on which feature was added in which version.
* Using GitHub Enterprise
diff --git a/src/site/apt/examples/configuring-trac-report.apt.vm
b/src/site/apt/examples/configuring-trac-report.apt.vm
index dfd4067..001e6c5 100644
--- a/src/site/apt/examples/configuring-trac-report.apt.vm
+++ b/src/site/apt/examples/configuring-trac-report.apt.vm
@@ -36,7 +36,7 @@ Configuring the Trac Report
accessible via no authentication, basic authentication or NTLM authentication.
If you've used form authentication then you are out of luck.
- Your Trac installation needs to have the
{{{http://trac-hacks.org/wiki/XmlRpcPlugin}XML-RPC plugin}}
+ Your Trac installation needs to have the
{{{https://trac-hacks.org/wiki/XmlRpcPlugin}XML-RPC plugin}}
installed and working for this plugin to be able to read the tickets.
** Basic Report Configuration
@@ -55,7 +55,7 @@ Configuring the Trac Report
** Configuring a Custom Query
The exact query can configured in the <<<\<query\>>>> element.
- See {{{http://trac.edgewall.org/wiki/TracQuery}TracQuery}} for the exact
syntax.
+ See {{{https://trac.edgewall.org/wiki/TracQuery}TracQuery}} for the exact
syntax.
+-----------------+
...
diff --git a/src/site/apt/examples/customizing-jira-report.apt.vm
b/src/site/apt/examples/customizing-jira-report.apt.vm
index 250a5f7..f2a4eb2 100644
--- a/src/site/apt/examples/customizing-jira-report.apt.vm
+++ b/src/site/apt/examples/customizing-jira-report.apt.vm
@@ -31,7 +31,7 @@ Customizing the JIRA Report
<<Note:>> Most of the features used in this document were introduced in
version
<<2.0>> of the Changes Plugin. See the
- {{{../jira-report-mojo.html}goal documentation}} for detailed info on which
+ {{{../jira-mojo.html}goal documentation}} for detailed info on which
feature was added in which version.
* Selecting version(s)
@@ -174,7 +174,7 @@ Customizing the JIRA Report
+-----------------+
You can also filter by <<<\<component\>>>> and <<<\<priorityIds\>>>>. See the
- {{{../jira-report-mojo.html}goal documentation}} for info on how to use them.
+ {{{../jira-mojo.html}goal documentation}} for info on how to use them.
** Using JIRA syntax
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 7132fbf..6902c89 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -47,22 +47,20 @@ ${project.name}
* {{{./changes-validate-mojo.html}changes:changes-validate}} validate the
<<<changes.xml>>> file.
- * {{{./changes-report-mojo.html}changes:changes-report}} create a report
from <<<changes.xml>>> file.
+ * {{{./changes-mojo.html}changes:changes}} create a report from
<<<changes.xml>>> file.
- * {{{./jira-report-mojo.html}changes:jira-report}} create a report from
issues downloaded from {{{http://www.atlassian.com/software/jira/}JIRA}}.
+ * {{{./jira-mojo.html}changes:jira}} create a report from issues downloaded
from {{{https://www.atlassian.com/software/jira/}JIRA}}.
- * {{{./trac-report-mojo.html}changes:trac-report}} create a report from
issues downloaded from {{{http://trac.edgewall.org/}Trac}}.
+ * {{{./trac-mojo.html}changes:trac}} create a report from issues downloaded
from {{{https://trac.edgewall.org/}Trac}}.
- * {{{./github-report-mojo.html}changes:github-report}} create a report from
issues downloaded from {{{http://github.com/}GitHub}}.
+ * {{{./github-mojo.html}changes:github}} create a report from issues
downloaded from {{{https://github.com/}GitHub}}.
[]
* Usage
General instructions on how to use the Changes Plugin can be found on the
{{{./usage.html}usage page}}. Some more
- specific use cases are described in the examples given below. Last but not
least, users occasionally contribute
- additional examples, tips or errata to the
- {{{http://docs.codehaus.org/display/MAVENUSER/Changes+Plugin}plugin's wiki
page}}.
+ specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a
look at the {{{./faq.html}FAQ}} and feel
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts
to the mailing list are archived and could
@@ -75,7 +73,7 @@ ${project.name}
entire debug logs, POMs or most preferably little demo projects attached to
the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project
from our
{{{./scm.html}source repository}} and will find supplementary information in
the
- {{{http://maven.apache.org/guides/development/guide-helping.html}guide to
helping with Maven}}.
+ {{{https://maven.apache.org/guides/development/guide-helping.html}guide to
helping with Maven}}.
* Migration to 3.x
@@ -89,6 +87,24 @@ ${project.name}
* tag <<<action/fixedIssues>>> - was changed to an attribute of <<action>>
tag, it also can be comma separated.
+** Reports goals and output names
+
+ The reports output filename and goals name were changed for alignment with
other reporting plugins from <<<org.apache.maven.plugins>>>.
+
+ See the following table for changes:
+
+*---------------------------+-------------------------------------+
+| <<goal name>> | <<output name>> |
+*---------------------------+-------------------------------------+
+| changes-report -> changes | changes-report.html -> changes.html |
+*---------------------------+-------------------------------------+
+| github-report -> github | github-report.html -> github.html |
+*---------------------------+-------------------------------------+
+| jira-report -> jira | jira-report.html -> jira.html |
+*---------------------------+-------------------------------------+
+| trac-report -> trac | trac-report.html -> trac.html |
+*---------------------------+-------------------------------------+
+
* Examples
To provide you with better understanding of some usages of the Changes
Plugin,
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index e3f1b75..23e2929 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -89,7 +89,7 @@ Usage
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
@@ -170,7 +170,7 @@ mvn site
*---------------+--------------------------------------------------------+
If you use an issue management system other than the ones above, you need to
- {{{./changes-report-mojo.html#issueLinkTemplatePerSystem}configure an issue
+ {{{./changes-mojo.html#issueLinkTemplatePerSystem}configure an issue
link template for it}}.
We would love to extend the table above with more issue management systems,
so if you have a working configuration that is not listed above, please tell
@@ -217,7 +217,7 @@ mvn site
<reportSets>
<reportSet>
<reports>
- <report>jira-report</report>
+ <report>jira</report>
</reports>
</reportSet>
</reportSets>
@@ -270,7 +270,7 @@ mvn site
<reportSets>
<reportSet>
<reports>
- <report>github-report</report>
+ <report>github</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/site/site.xml b/src/site/site.xml
index ed49170..7b95f97 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -45,7 +45,7 @@ under the License.
<item name="changes.xsd" href="xsd/changes-2.0.0.xsd"/>
</menu>
<menu name="Samples">
- <item name="Sample Changes Report" href="changes-report.html"/>
+ <item name="Sample Changes Report" href="changes.html"/>
</menu>
<menu name="Examples">
<item name="Alternate Location for the changes.xml File"
href="examples/alternate-changes-xml-location.html"/>
diff --git
a/src/test/java/org/apache/maven/plugins/changes/jira/JiraUnicodeTestCase.java
b/src/test/java/org/apache/maven/plugins/changes/jira/JiraUnicodeTestCase.java
index ec62b00..0c749cc 100644
---
a/src/test/java/org/apache/maven/plugins/changes/jira/JiraUnicodeTestCase.java
+++
b/src/test/java/org/apache/maven/plugins/changes/jira/JiraUnicodeTestCase.java
@@ -95,7 +95,7 @@ public class JiraUnicodeTestCase extends AbstractMojoTestCase
{
outputDir.mkdirs();
mojo.setReportOutputDirectory(outputDir);
mojo.execute();
- String reportHtml = FileUtils.readFileToString(new File(outputDir,
"jira-report.html"), "utf-8");
+ String reportHtml = FileUtils.readFileToString(new File(outputDir,
"jira.html"), "utf-8");
int turtleIndex = reportHtml.indexOf(TEST_TURTLES);
assertTrue(turtleIndex >= 0);
}
