This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-changes-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new f72d9c4 [MCHANGES-453] Align report output and goals names
f72d9c4 is described below
commit f72d9c421d548b8446a225571ae2531505f946a2
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Tue Dec 3 22:51:37 2024 +0100
[MCHANGES-453] Align report output and goals names
---
.../report-aggregated-changes-generation/pom.xml | 2 +-
.../verify.groovy | 4 +-
src/it/report-changes-generation/pom.xml | 2 +-
src/it/report-changes-generation/verify.groovy | 12 +++---
src/it/report-changes-interpolation/pom.xml | 2 +-
src/it/report-changes-interpolation/verify.bsh | 16 ++++----
src/it/report-changes-nofile/pom.xml | 2 +-
src/it/report-changes-skip-snapshots/pom.xml | 2 +-
.../pom.xml | 2 +-
.../verify.bsh | 12 +++---
src/it/report-changes-system/pom.xml | 2 +-
src/it/report-changes-system/verify.bsh | 10 ++---
src/it/report-github/pom.xml | 2 +-
src/it/report-github/verify.groovy | 2 +-
src/it/report-jira-invalid-issuemanagement/pom.xml | 4 +-
src/it/report-jira/pom.xml | 2 +-
src/it/report-jira/verify.groovy | 2 +-
.../plugins/changes/ChangesDeprecatedReport.java} | 31 ++++++++------
.../maven/plugins/changes/ChangesReport.java | 6 +--
...{GitHubReport.java => GitHubChangesReport.java} | 8 ++--
.../changes/github/GitHubDeprecatedReport.java} | 32 +++++++++------
.../{JiraReport.java => JiraChangesReport.java} | 10 ++---
.../changes/jira/JiraDeprecatedReport.java} | 28 ++++++-------
.../{TracReport.java => TracChangesReport.java} | 6 +--
.../changes/trac/TracDeprecatedReport.java} | 24 ++++++-----
.../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 | 48 +++++++++++-----------
src/site/site.xml | 2 +-
...aReportTest.java => JiraChangesReportTest.java} | 6 +--
.../plugins/changes/jira/JiraUnicodeTestCase.java | 6 +--
34 files changed, 180 insertions(+), 151 deletions(-)
diff --git a/src/it/report-aggregated-changes-generation/pom.xml
b/src/it/report-aggregated-changes-generation/pom.xml
index f3b5cdb..2439511 100644
--- a/src/it/report-aggregated-changes-generation/pom.xml
+++ b/src/it/report-aggregated-changes-generation/pom.xml
@@ -104,7 +104,7 @@
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-aggregated-changes-generation/verify.groovy
b/src/it/report-aggregated-changes-generation/verify.groovy
index 24e8113..035b2ce 100644
--- a/src/it/report-aggregated-changes-generation/verify.groovy
+++ b/src/it/report-aggregated-changes-generation/verify.groovy
@@ -16,8 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
-assert new File(basedir, 'target/site/changes-report.html').exists();
-content = new File(basedir, 'target/site/changes-report.html').text;
+assert new File(basedir, 'target/site/changes.html').exists();
+content = new File(basedir, 'target/site/changes.html').text;
assert content.contains( 'Changes' );
diff --git a/src/it/report-changes-generation/pom.xml
b/src/it/report-changes-generation/pom.xml
index 33a446a..5d0685f 100644
--- a/src/it/report-changes-generation/pom.xml
+++ b/src/it/report-changes-generation/pom.xml
@@ -98,7 +98,7 @@
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-changes-generation/verify.groovy
b/src/it/report-changes-generation/verify.groovy
index d567238..2ffa67e 100644
--- a/src/it/report-changes-generation/verify.groovy
+++ b/src/it/report-changes-generation/verify.groovy
@@ -18,21 +18,21 @@
*/
-def report = new File(basedir, 'target/site/changes-report.html')
+def report = new File(basedir, 'target/site/changes.html')
assert report.exists()
def content = report.text
-assert content.contains('Changes'): 'changes-report.html doesn\'t contain
Changes title'
+assert content.contains('Changes'): 'changes.html doesn\'t contain Changes
title'
-assert content.contains('href="http://myjira/browse/MCHANGES-88";'):
'changes-report.html doesn\'t contain jira issue link'
+assert content.contains('href="http://myjira/browse/MCHANGES-88";'):
'changes.html doesn\'t contain jira issue link'
// Test for output problem caused by only using <dueTo> elements
-assert !content.contains('Thanks to , '): 'changes-report.html has too many
dueTos in the Map'
+assert !content.contains('Thanks to , '): 'changes.html has too many dueTos in
the Map'
// Tests output problems caused by only using fixedIssues attribute
-assert content.contains('bug-12345'): 'changes-report.html doesn\'t contain
issue text for issue specified with <fixes> element'
-assert !content.contains('Fixes .'): 'changes-report.html doesn\'t handle
empty fixes attribute properly'
+assert content.contains('bug-12345'): 'changes.html doesn\'t contain issue
text for issue specified with <fixes> element'
+assert !content.contains('Fixes .'): 'changes.html doesn\'t handle empty fixes
attribute properly'
// due-to verification
assert content.contains('<a class="externalLink"
href="mailto:j...@doe.com";>John Doe</a>')
diff --git a/src/it/report-changes-interpolation/pom.xml
b/src/it/report-changes-interpolation/pom.xml
index e425f35..373d72b 100644
--- a/src/it/report-changes-interpolation/pom.xml
+++ b/src/it/report-changes-interpolation/pom.xml
@@ -96,7 +96,7 @@
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-changes-interpolation/verify.bsh
b/src/it/report-changes-interpolation/verify.bsh
index 72dade0..71319f5 100644
--- a/src/it/report-changes-interpolation/verify.bsh
+++ b/src/it/report-changes-interpolation/verify.bsh
@@ -29,7 +29,7 @@ boolean result = true;
try
{
- File report = new File( basedir, "target/site/changes-report.html" );
+ File report = new File( basedir, "target/site/changes.html" );
if ( !report.exists() )
{
System.err.println( "report file is missing." );
@@ -45,14 +45,14 @@ try
int indexOf = reportContent.indexOf( "Changes" );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain Changes title"
);
+ System.err.println( "changes.html doesn't contain Changes title" );
return false;
}
indexOf = reportContent.indexOf(
"href=\"http://myjira/browse/MCHANGES-88\""; );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain jira issue
link" );
+ System.err.println( "changes.html doesn't contain jira issue link" );
return false;
}
@@ -60,7 +60,7 @@ try
indexOf = reportContent.indexOf( "Thanks to , " );
if ( indexOf != -1 )
{
- System.err.println( "changes-report.html has too many dueTos in the Map"
);
+ System.err.println( "changes.html has too many dueTos in the Map" );
return false;
}
@@ -68,20 +68,20 @@ try
indexOf = reportContent.indexOf( "bug-12345" );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain issue text for
issue specified with <fixes> element" );
+ System.err.println( "changes.html doesn't contain issue text for issue
specified with <fixes> element" );
return false;
}
indexOf = reportContent.indexOf( "Fixes ." );
if ( indexOf != -1 )
{
- System.err.println( "changes-report.html doesn't handle empty fixes
attribute properly" );
+ System.err.println( "changes.html doesn't handle empty fixes attribute
properly" );
return false;
}
indexOf = reportContent.indexOf( "<a href=\"#a99.0\">" );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain version from
pom" );
+ System.err.println( "changes.html doesn't contain version from pom" );
return false;
}
@@ -92,7 +92,7 @@ try
indexOf = reportContent.indexOf( formattedDate );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain publishDate" );
+ System.err.println( "changes.html doesn't contain publishDate" );
return false;
}
diff --git a/src/it/report-changes-nofile/pom.xml
b/src/it/report-changes-nofile/pom.xml
index 5385b79..4e3c8c0 100644
--- a/src/it/report-changes-nofile/pom.xml
+++ b/src/it/report-changes-nofile/pom.xml
@@ -93,7 +93,7 @@
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-changes-skip-snapshots/pom.xml
b/src/it/report-changes-skip-snapshots/pom.xml
index e35339a..b981955 100644
--- a/src/it/report-changes-skip-snapshots/pom.xml
+++ b/src/it/report-changes-skip-snapshots/pom.xml
@@ -93,7 +93,7 @@
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-changes-system-noissuemanagement/pom.xml
b/src/it/report-changes-system-noissuemanagement/pom.xml
index 69ce525..568fe68 100644
--- a/src/it/report-changes-system-noissuemanagement/pom.xml
+++ b/src/it/report-changes-system-noissuemanagement/pom.xml
@@ -92,7 +92,7 @@
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-changes-system-noissuemanagement/verify.bsh
b/src/it/report-changes-system-noissuemanagement/verify.bsh
index f74aeb4..eb8561b 100644
--- a/src/it/report-changes-system-noissuemanagement/verify.bsh
+++ b/src/it/report-changes-system-noissuemanagement/verify.bsh
@@ -27,7 +27,7 @@ boolean result = true;
try
{
- File report = new File( basedir, "target/site/changes-report.html" );
+ File report = new File( basedir, "target/site/changes.html" );
if ( !report.exists() )
{
System.err.println( "report file is missing." );
@@ -43,32 +43,32 @@ try
int indexOf = reportContent.indexOf( "Changes" );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain Changes title"
);
+ System.err.println( "changes.html doesn't contain Changes title" );
return false;
}
indexOf = reportContent.indexOf(
"href=\"http://myjira/browse/MCHANGES-88\""; );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain jira issue
link" );
+ System.err.println( "changes.html doesn't contain jira issue link" );
return false;
}
indexOf = reportContent.indexOf( "href=\"http://localhost/1212\""; );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain qc issue link"
);
+ System.err.println( "changes.html doesn't contain qc issue link" );
return false;
}
indexOf = reportContent.indexOf(
"href=\"http://www.redmine.org/show/issue/88\""; );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain redmine issue
link" );
+ System.err.println( "changes.html doesn't contain redmine issue link" );
return false;
}
indexOf = reportContent.indexOf( "2008-01-01" );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain date
2008-01-01" );
+ System.err.println( "changes.html doesn't contain date 2008-01-01" );
return false;
}
diff --git a/src/it/report-changes-system/pom.xml
b/src/it/report-changes-system/pom.xml
index abf9a65..6323c5e 100644
--- a/src/it/report-changes-system/pom.xml
+++ b/src/it/report-changes-system/pom.xml
@@ -98,7 +98,7 @@
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-changes-system/verify.bsh
b/src/it/report-changes-system/verify.bsh
index 2e6de8c..ce4c4da 100644
--- a/src/it/report-changes-system/verify.bsh
+++ b/src/it/report-changes-system/verify.bsh
@@ -27,7 +27,7 @@ boolean result = true;
try
{
- File report = new File( basedir, "target/site/en/changes-report.html" );
+ File report = new File( basedir, "target/site/en/changes.html" );
if ( !report.exists() )
{
System.err.println( "report file is missing." );
@@ -43,26 +43,26 @@ try
int indexOf = reportContent.indexOf( "Changes" );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain Changes title"
);
+ System.err.println( "changes.html doesn't contain Changes title" );
return false;
}
indexOf = reportContent.indexOf(
"href=\"http://myjira/browse/MCHANGES-88\""; );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain jira issue
link" );
+ System.err.println( "changes.html doesn't contain jira issue link" );
return false;
}
indexOf = reportContent.indexOf( "href=\"http://localhost/1212\""; );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain qc issue link"
);
+ System.err.println( "changes.html doesn't contain qc issue link" );
return false;
}
indexOf = reportContent.indexOf( "2008-01-01" );
if ( indexOf < 0 )
{
- System.err.println( "changes-report.html doesn't contain date
2008-01-01" );
+ System.err.println( "changes.html doesn't contain date 2008-01-01" );
return false;
}
}
diff --git a/src/it/report-github/pom.xml b/src/it/report-github/pom.xml
index 2e48d23..c4e126d 100644
--- a/src/it/report-github/pom.xml
+++ b/src/it/report-github/pom.xml
@@ -64,7 +64,7 @@
<reportSets>
<reportSet>
<reports>
- <report>github-report</report>
+ <report>github-changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-github/verify.groovy
b/src/it/report-github/verify.groovy
index b316f81..9cc644c 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-changes.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-invalid-issuemanagement/pom.xml
b/src/it/report-jira-invalid-issuemanagement/pom.xml
index ea4ab6f..19360b1 100644
--- a/src/it/report-jira-invalid-issuemanagement/pom.xml
+++ b/src/it/report-jira-invalid-issuemanagement/pom.xml
@@ -89,8 +89,8 @@
<reportSet>
<reports>
<!-- Issue Management in the POM is JIRA, but we're trying to
generate GitHub and Trac report -->
- <report>github-report</report>
- <report>trac-report</report>
+ <report>github-changes</report>
+ <report>trac-changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-jira/pom.xml b/src/it/report-jira/pom.xml
index 49c3ed5..12faceb 100644
--- a/src/it/report-jira/pom.xml
+++ b/src/it/report-jira/pom.xml
@@ -64,7 +64,7 @@
<reportSets>
<reportSet>
<reports>
- <report>jira-report</report>
+ <report>jira-changes</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/it/report-jira/verify.groovy b/src/it/report-jira/verify.groovy
index a80f3ce..dcd81ec 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-changes.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/it/report-aggregated-changes-generation/verify.groovy
b/src/main/java/org/apache/maven/plugins/changes/ChangesDeprecatedReport.java
similarity index 56%
copy from src/it/report-aggregated-changes-generation/verify.groovy
copy to
src/main/java/org/apache/maven/plugins/changes/ChangesDeprecatedReport.java
index 24e8113..9bb2c73 100644
--- a/src/it/report-aggregated-changes-generation/verify.groovy
+++
b/src/main/java/org/apache/maven/plugins/changes/ChangesDeprecatedReport.java
@@ -16,20 +16,25 @@
* specific language governing permissions and limitations
* under the License.
*/
-assert new File(basedir, 'target/site/changes-report.html').exists();
-content = new File(basedir, 'target/site/changes-report.html').text;
+package org.apache.maven.plugins.changes;
-assert content.contains( 'Changes' );
+import javax.inject.Inject;
-assert content.contains( '<th>Module1</th>' );
-assert !content.contains( '<th>Module2</th>' );
-assert content.contains( '<th>Module3</th>' );
-assert !content.contains( '<th>Module4</th>' );
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.shared.filtering.MavenFileFilter;
-assert content.contains( 'MCHANGES-88' );
-assert content.contains( 'MCHANGES-1' );
-assert content.contains( 'bug-12345' );
-
-assert content.contains( 'No changes in this release.' );
+/**
+ * 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 ChangesDeprecatedReport extends ChangesReport {
-return true;
+ @Inject
+ public ChangesDeprecatedReport(MavenFileFilter mavenFileFilter) {
+ super(mavenFileFilter);
+ }
+}
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/main/java/org/apache/maven/plugins/changes/github/GitHubReport.java
b/src/main/java/org/apache/maven/plugins/changes/github/GitHubChangesReport.java
similarity index 97%
rename from
src/main/java/org/apache/maven/plugins/changes/github/GitHubReport.java
rename to
src/main/java/org/apache/maven/plugins/changes/github/GitHubChangesReport.java
index 23b5d69..858f847 100644
--- a/src/main/java/org/apache/maven/plugins/changes/github/GitHubReport.java
+++
b/src/main/java/org/apache/maven/plugins/changes/github/GitHubChangesReport.java
@@ -45,8 +45,8 @@ import org.apache.maven.settings.crypto.SettingsDecrypter;
* @author Bryan Baugher
* @since 2.8
*/
-@Mojo(name = "github-report", threadSafe = true)
-public class GitHubReport extends AbstractChangesReport {
+@Mojo(name = "github-changes", threadSafe = true)
+public class GitHubChangesReport extends AbstractChangesReport {
/**
* Valid Github columns.
@@ -118,7 +118,7 @@ public class GitHubReport extends AbstractChangesReport {
private SettingsDecrypter settingsDecrypter;
@Inject
- public GitHubReport(SettingsDecrypter settingsDecrypter) {
+ public GitHubChangesReport(SettingsDecrypter settingsDecrypter) {
this.settingsDecrypter = settingsDecrypter;
}
@@ -129,7 +129,7 @@ public class GitHubReport extends AbstractChangesReport {
@Override
@Deprecated
public String getOutputName() {
- return "github-report";
+ return "github-changes";
}
@Override
diff --git a/src/it/report-aggregated-changes-generation/verify.groovy
b/src/main/java/org/apache/maven/plugins/changes/github/GitHubDeprecatedReport.java
similarity index 57%
copy from src/it/report-aggregated-changes-generation/verify.groovy
copy to
src/main/java/org/apache/maven/plugins/changes/github/GitHubDeprecatedReport.java
index 24e8113..66bfaf8 100644
--- a/src/it/report-aggregated-changes-generation/verify.groovy
+++
b/src/main/java/org/apache/maven/plugins/changes/github/GitHubDeprecatedReport.java
@@ -16,20 +16,26 @@
* specific language governing permissions and limitations
* under the License.
*/
-assert new File(basedir, 'target/site/changes-report.html').exists();
-content = new File(basedir, 'target/site/changes-report.html').text;
+package org.apache.maven.plugins.changes.github;
-assert content.contains( 'Changes' );
+import javax.inject.Inject;
-assert content.contains( '<th>Module1</th>' );
-assert !content.contains( '<th>Module2</th>' );
-assert content.contains( '<th>Module3</th>' );
-assert !content.contains( '<th>Module4</th>' );
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.settings.crypto.SettingsDecrypter;
-assert content.contains( 'MCHANGES-88' );
-assert content.contains( 'MCHANGES-1' );
-assert content.contains( 'bug-12345' );
-
-assert content.contains( 'No changes in this release.' );
+/**
+ * Goal which downloads issues from GitHub and generates a report.
+ *
+ * @author Bryan Baugher
+ * @since 2.8
+ * @deprecated use {@code github-changes} goal
+ */
+@Deprecated
+@Mojo(name = "github-report", threadSafe = true)
+public class GitHubDeprecatedReport extends GitHubChangesReport {
-return true;
+ @Inject
+ public GitHubDeprecatedReport(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/JiraChangesReport.java
similarity index 98%
rename from src/main/java/org/apache/maven/plugins/changes/jira/JiraReport.java
rename to
src/main/java/org/apache/maven/plugins/changes/jira/JiraChangesReport.java
index 7b0ffe7..c916fe8 100644
--- a/src/main/java/org/apache/maven/plugins/changes/jira/JiraReport.java
+++ b/src/main/java/org/apache/maven/plugins/changes/jira/JiraChangesReport.java
@@ -43,10 +43,10 @@ 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)
-public class JiraReport extends AbstractChangesReport {
+@Mojo(name = "jira-changes", threadSafe = true)
+public class JiraChangesReport extends AbstractChangesReport {
/**
* Valid JIRA columns.
*/
@@ -286,7 +286,7 @@ public class JiraReport extends AbstractChangesReport {
private final SettingsDecrypter settingsDecrypter;
@Inject
- public JiraReport(SettingsDecrypter settingsDecrypter) {
+ public JiraChangesReport(SettingsDecrypter settingsDecrypter) {
this.settingsDecrypter = settingsDecrypter;
}
@@ -375,7 +375,7 @@ public class JiraReport extends AbstractChangesReport {
@Override
@Deprecated
public String getOutputName() {
- return "jira-report";
+ return "jira-changes";
}
/* --------------------------------------------------------------------- */
diff --git
a/src/test/java/org/apache/maven/plugins/changes/jira/JiraReportTest.java
b/src/main/java/org/apache/maven/plugins/changes/jira/JiraDeprecatedReport.java
similarity index 58%
copy from
src/test/java/org/apache/maven/plugins/changes/jira/JiraReportTest.java
copy to
src/main/java/org/apache/maven/plugins/changes/jira/JiraDeprecatedReport.java
index d076190..42098b6 100644
--- a/src/test/java/org/apache/maven/plugins/changes/jira/JiraReportTest.java
+++
b/src/main/java/org/apache/maven/plugins/changes/jira/JiraDeprecatedReport.java
@@ -18,24 +18,24 @@
*/
package org.apache.maven.plugins.changes.jira;
-import org.apache.maven.plugin.testing.AbstractMojoTestCase;
+import javax.inject.Inject;
+
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.settings.crypto.SettingsDecrypter;
/**
- * Unit tests for {@link JiraReport}.
+ * Goal which downloads issues from the Issue Tracking System and generates a
report.
*
- * @author jrh3k5
- * @since 2.8
+ * @author <a href="mailto:jr...@exist.com";>Johnny R. Ruiz III</a>
+ * @since 2.0
+ * @deprecated use {@code jira-changes} goal
*/
-public class JiraReportTest extends AbstractMojoTestCase {
- private final JiraReport mojo = new JiraReport(null);
+@Deprecated
+@Mojo(name = "jira-report", threadSafe = true)
+public class JiraDeprecatedReport extends JiraChangesReport {
- /**
- * If the mojo has been marked to be skipped, then it should indicate that
the report cannot be generated.
- *
- * @throws Exception If any errors occur during the test run.
- */
- public void testCanGenerateReportSkipped() throws Exception {
- setVariableValueToObject(mojo, "skip", Boolean.TRUE);
- assertFalse(mojo.canGenerateReport());
+ @Inject
+ public JiraDeprecatedReport(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/TracChangesReport.java
similarity index 98%
rename from src/main/java/org/apache/maven/plugins/changes/trac/TracReport.java
rename to
src/main/java/org/apache/maven/plugins/changes/trac/TracChangesReport.java
index c6eb120..0add68d 100644
--- a/src/main/java/org/apache/maven/plugins/changes/trac/TracReport.java
+++ b/src/main/java/org/apache/maven/plugins/changes/trac/TracChangesReport.java
@@ -42,8 +42,8 @@ import org.apache.xmlrpc.XmlRpcException;
* @version $Id$
* @since 2.1
*/
-@Mojo(name = "trac-report", threadSafe = true)
-public class TracReport extends AbstractChangesReport {
+@Mojo(name = "trac-changes", threadSafe = true)
+public class TracChangesReport extends AbstractChangesReport {
/**
* Valid Trac columns.
@@ -163,7 +163,7 @@ public class TracReport extends AbstractChangesReport {
@Override
@Deprecated
public String getOutputName() {
- return "trac-report";
+ return "trac-changes";
}
/* --------------------------------------------------------------------- */
diff --git a/src/it/report-jira/verify.groovy
b/src/main/java/org/apache/maven/plugins/changes/trac/TracDeprecatedReport.java
similarity index 62%
copy from src/it/report-jira/verify.groovy
copy to
src/main/java/org/apache/maven/plugins/changes/trac/TracDeprecatedReport.java
index a80f3ce..ea34777 100644
--- a/src/it/report-jira/verify.groovy
+++
b/src/main/java/org/apache/maven/plugins/changes/trac/TracDeprecatedReport.java
@@ -16,16 +16,18 @@
* 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-changes} goal
+ */
+@Deprecated
+@Mojo(name = "trac-report", threadSafe = true)
+public class TracDeprecatedReport extends TracChangesReport {}
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..aaca72f 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-changes-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..a4f0900 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-changes-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-changes-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..4c62cc7 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-changes-mojo.html}changes:jira-changes}} 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-changes-mojo.html}changes:trac-changes}} 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-changes-mojo.html}changes:github-changes}} 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.
+** Report 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-changes | github-report.html -> github-changes.html |
+*---------------------------------+-------------------------------------------+
+| jira-report -> jira-changes | jira-report.html -> jira-changes.html |
+*---------------------------------+-------------------------------------------+
+| trac-report -> trac-changes | trac-report.html -> trac-changes.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..0eb5446 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -40,7 +40,7 @@ Usage
In order to use this goal, simply create a <<<changes.xml>>> file in the
<<<src/changes/>>> directory.
Here's an example of a typical <<<changes.xml>>>, showing the syntax:
--------------------
++-------------------+
<document xmlns="http://maven.apache.org/changes/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/changes/2.0.0
https://maven.apache.org/xsd/changes-2.0.0.xsd";>
@@ -69,7 +69,7 @@ Usage
</release>
</body>
</document>
--------------------
++-------------------+
See the {{{./changes.html}Changes Reference}} for details regarding the
<<<\<release\>>>> and <<<\<action\>>>> elements and their attributes.
@@ -77,7 +77,7 @@ Usage
To generate the Changes Report, insert the Changes Plugin in the
<<<\<reporting\>>>> section of your project's <<<pom.xml>>>
--------------------
++-------------------+
<project>
...
<reporting>
@@ -89,7 +89,7 @@ Usage
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
+ <report>changes</report>
</reports>
</reportSet>
</reportSets>
@@ -98,7 +98,7 @@ Usage
</reporting>
...
</project>
--------------------
++-------------------+
and execute the <<<site>>> phase to generate the report.
@@ -116,7 +116,7 @@ mvn site
different issue management systems. All you have to to is enter your issue
management system and the URL to it in your POM. It can look like this:
------
++-----+
<project>
...
<issueManagement>
@@ -125,7 +125,7 @@ mvn site
</issueManagement>
...
</project>
------
++-----+
If you have a previous configuration for <<<\<issueLinkTemplatePerSystem\>>>>
in your POM, you can probably throw that away when you start using version
2.4,
@@ -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
@@ -191,7 +191,7 @@ mvn site
the <<<pom.xml>>> of your project must be configured. It might look something
like this:
--------------------
++-------------------+
<project>
...
<issueManagement>
@@ -200,12 +200,12 @@ mvn site
</issueManagement>
...
</project>
--------------------
++-------------------+
To generate the JIRA Report, insert the Changes Plugin in the
<<<\<reporting\>>>> section of your project's <<<pom.xml>>>
--------------------
++-------------------+
<project>
...
<reporting>
@@ -217,7 +217,7 @@ mvn site
<reportSets>
<reportSet>
<reports>
- <report>jira-report</report>
+ <report>jira-changes</report>
</reports>
</reportSet>
</reportSets>
@@ -226,7 +226,7 @@ mvn site
</reporting>
...
</project>
--------------------
++-------------------+
and execute the site goal to generate the report.
@@ -244,7 +244,7 @@ mvn site
the <<<pom.xml>>> of your project must be configured. It might look something
like this:
--------------------
++-------------------+
<project>
...
<issueManagement>
@@ -253,12 +253,12 @@ mvn site
</issueManagement>
...
</project>
--------------------
++-------------------+
To generate the GitHub Report, insert the Changes Plugin in the
<<<\<reporting\>>>> section of your project's <<<pom.xml>>>
--------------------
++-------------------+
<project>
...
<reporting>
@@ -270,7 +270,7 @@ mvn site
<reportSets>
<reportSet>
<reports>
- <report>github-report</report>
+ <report>github-changes</report>
</reports>
</reportSet>
</reportSets>
@@ -279,7 +279,7 @@ mvn site
</reporting>
...
</project>
--------------------
++-------------------+
and execute the site goal to generate the report.
@@ -309,7 +309,7 @@ mvn site
<add> corresponds to 'New Feature', <fix> corresponds to 'Bug', and <update>
corresponds to 'Improvement'.
--------------------
++-------------------+
<project>
...
<build>
@@ -338,7 +338,7 @@ mvn site
</build>
...
</project>
--------------------
++-------------------+
You can now generate the announcement by executing the command below:
@@ -349,7 +349,7 @@ mvn changes:announcement-generate
If you want to generate the announcement based on JIRA you need to
configure that in your <<<pom.xml>>>, like this:
--------------------
++-------------------+
<project>
...
<build>
@@ -370,12 +370,12 @@ mvn changes:announcement-generate
</build>
...
</project>
--------------------
++-------------------+
To generate the announcement based on <<both>> a <<<changes.xml>>> file and
JIRA
you should configure your <<<pom.xml>>> like this:
--------------------
++-------------------+
<project>
...
<build>
@@ -397,7 +397,7 @@ mvn changes:announcement-generate
</build>
...
</project>
--------------------
++-------------------+
This is how you send an email with the generated announcement:
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/JiraReportTest.java
b/src/test/java/org/apache/maven/plugins/changes/jira/JiraChangesReportTest.java
similarity index 88%
rename from
src/test/java/org/apache/maven/plugins/changes/jira/JiraReportTest.java
rename to
src/test/java/org/apache/maven/plugins/changes/jira/JiraChangesReportTest.java
index d076190..af9ebd4 100644
--- a/src/test/java/org/apache/maven/plugins/changes/jira/JiraReportTest.java
+++
b/src/test/java/org/apache/maven/plugins/changes/jira/JiraChangesReportTest.java
@@ -21,13 +21,13 @@ package org.apache.maven.plugins.changes.jira;
import org.apache.maven.plugin.testing.AbstractMojoTestCase;
/**
- * Unit tests for {@link JiraReport}.
+ * Unit tests for {@link JiraChangesReport}.
*
* @author jrh3k5
* @since 2.8
*/
-public class JiraReportTest extends AbstractMojoTestCase {
- private final JiraReport mojo = new JiraReport(null);
+public class JiraChangesReportTest extends AbstractMojoTestCase {
+ private final JiraChangesReport mojo = new JiraChangesReport(null);
/**
* If the mojo has been marked to be skipped, then it should indicate that
the report cannot be generated.
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..dfb230c 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
@@ -53,7 +53,7 @@ public class JiraUnicodeTestCase extends AbstractMojoTestCase
{
assertNotNull(pom);
assertTrue(pom.exists());
- JiraReport mojo = lookupMojo("jira-report", pom);
+ JiraChangesReport mojo = lookupMojo("jira-changes", pom);
MavenProject project = new JiraUnicodeTestProjectStub();
MavenSession session = newMavenSession(project);
@@ -78,7 +78,7 @@ public class JiraUnicodeTestCase extends AbstractMojoTestCase
{
setVariableValueToObject(mojo, "siteDirectory", new
File("non-existing"));
setVariableValueToObject(mojo, "mavenSession", session);
- setVariableValueToObject(mojo, "mojoExecution", new MojoExecution(new
Plugin(), "jira-report", "default"));
+ setVariableValueToObject(mojo, "mojoExecution", new MojoExecution(new
Plugin(), "jira-changes", "default"));
RestJiraDownloader mock = mock(RestJiraDownloader.class);
Issue issue = new Issue();
@@ -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-changes.html"), "utf-8");
int turtleIndex = reportHtml.indexOf(TEST_TURTLES);
assertTrue(turtleIndex >= 0);
}
