Skip to content

Commit 3966e2f

Browse files
committed
[SUREFIRE-2162] Document upcoming mojo and file names change
This closes #628
1 parent c7af276 commit 3966e2f

File tree

1 file changed

+18
-0
lines changed
  • maven-surefire-report-plugin/src/site/apt

1 file changed

+18
-0
lines changed

maven-surefire-report-plugin/src/site/apt/index.apt

+18
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,24 @@ Maven Surefire Report Plugin
5858
| 3.0.0 | {{{https://issues.apache.org/jira/issues/?jql=project%20%3D%20SUREFIRE%20AND%20fixVersion%20%3D%203.0%20ORDER%20BY%20priority%20DESC%2C%20key}ASF Release versions}} \ |
5959
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6060

61+
* Upcoming Incompatibility Notice
62+
63+
With a future minor version several mojos and output filenames will change for alignment with other
64+
reporting plugins from <<<org.apache.maven.plugins>>>.
65+
To make you aware of that, see the following table for the upcoming changes:
66+
67+
*----------------------*--------------------------*-----------------------*------------------*
68+
|| Mojo Class Name || New Mojo Class Name || Output name || New Output Name |
69+
*----------------------+--------------------------+-----------------------+------------------+
70+
| <<<FailsafeReport>>> | <<<FailsafeReportOnly>>> | <<<failsafe-report>>> | <<<failsafe>>> |
71+
*----------------------+--------------------------+-----------------------+------------------+
72+
| <<<SurefireReport>>> | \u2013 | <<<suresafe-report>>> | <<<surefire>>> |
73+
*----------------------+--------------------------+-----------------------+------------------+
74+
| <<<SurefireReportOnly>>> | \u2013 | <<<suresafe-report>>> | <<<surefire>>> |
75+
*----------------------+--------------------------+-----------------------+------------------+
76+
77+
Details about this change can be found in {{{https://issues.apache.org/jira/browse/SUREFIRE-2161}SUREFIRE-2161}}.
78+
6179
* Goals Overview
6280

6381
The Surefire Report Plugin has three goals:

0 commit comments

Comments
 (0)