Skip to content

Commit 14ffae6

Browse files
committed
[MINVOKER-347] Document upcoming report file name change
1 parent 3df7c38 commit 14ffae6

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

src/site/apt/index.apt.vm

+15-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ ${project.name}
3434
This plugin is in particular handy to perform integration tests for other Maven plugins. The Invoker Plugin can be
3535
employed to run a set of test projects that have been designed to assert certain features of the plugin under test.
3636

37+
* Upcoming Incompatibility Notice
38+
39+
With a future (minor) the report output filename will change for alignment with other
40+
reporting plugins from <<<org.apache.maven.plugins>>>.
41+
To make you aware of that, see the following table for the upcoming changes:
42+
43+
*---------------------*----------------------*------------------*
44+
|| Mojo Class Name || Output name || New Output Name |
45+
*---------------------+----------------------+------------------+
46+
| <<<InvokerReport>>> | <<<invoker-report>>> | <<<invoker>>> |
47+
*---------------------+----------------------+------------------+
48+
49+
Details about this change can be found in {{{https://issues.apache.org/jira/browse/MINVOKER-346}MINVOKER-346}}.
50+
3751
* Goals Overview
3852

3953
The plugin has four goals meant to participate in the default build lifecycle:
@@ -98,7 +112,7 @@ ${project.name}
98112

99113
* {{{./examples/prepare-build-env.html}Prepare the Build Environment}} by building some setup projects before other projects.
100114

101-
* {{{./examples/integration-test-verify.html}Using with other integration test frameworks}} by decoupling checking
115+
* {{{./examples/integration-test-verify.html}Using with other integration test frameworks}} by decoupling checking
102116
the results of the integration tests from executing the integration tests.
103117

104118
[]

0 commit comments

Comments
 (0)