[maven-invoker-plugin] 01/01: [MINVOKER-347] Document upcoming report file name change

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-invoker-plugin.git

commit 14ffae65a9f0db6cf623da820e7444a9d9cd0501
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sun Jun 11 18:35:09 2023 +0200

    [MINVOKER-347] Document upcoming report file name change
---
 src/site/apt/index.apt.vm | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 4ffeda1..a05187c 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -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:
@@ -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.
 
   []