Skip to content

Commit

Permalink
[MINVOKER-347] Document upcoming report file name change
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-o committed Jun 11, 2023
1 parent 3df7c38 commit 14ffae6
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@ ${project.name}
This plugin is in particular handy to perform integration tests for other Maven plugins. The Invoker Plugin can be
employed to run a set of test projects that have been designed to assert certain features of the plugin under test.

* Upcoming Incompatibility Notice

With a future (minor) the report output filename will change for alignment with other
reporting plugins from <<<org.apache.maven.plugins>>>.
To make you aware of that, see the following table for the upcoming changes:

*---------------------*----------------------*------------------*
|| Mojo Class Name || Output name || New Output Name |
*---------------------+----------------------+------------------+
| <<<InvokerReport>>> | <<<invoker-report>>> | <<<invoker>>> |
*---------------------+----------------------+------------------+

Details about this change can be found in {{{https://issues.apache.org/jira/browse/MINVOKER-346}MINVOKER-346}}.

* Goals Overview

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

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

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

[]
Expand Down

0 comments on commit 14ffae6

Please sign in to comment.