[maven] 01/03: Fix build instructions

[gn...@apache.org]

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

gnodet pushed a commit to branch MNG-7129-maven-caching
in repository https://gitbox.apache.org/repos/asf/maven.git

commit 690071d1a3833a8195bc21878bf912cc4e3d0135
Author: Guillaume Nodet <gn...@gmail.com>
AuthorDate: Fri Dec 10 14:40:53 2021 +0100

    Fix build instructions
---
 README.md                                              | 18 +++++++++++++-----
 run-its.sh => build-maven.sh                           |  6 ++----
 .../caching/its/junit/IntegrationTestExtension.java    |  4 ++--
 3 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 3ef7e97..9d83181 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,20 @@
  limitations under the License.
 -->
 Apache Maven Build Cache Extension
-====================
+==================================
 
-Incremental Build and Cache
--------------
-This project provides an Incremental Build and Caching features which calculates out-of-date modules in the build dependencies graph and improves build times by avoiding re-building unnecessary modules.
-Read [cache guide](src/site/markdown/CACHE.md) for more details.
+This project provides a Build Cache Extension feature which calculates out-of-date modules in the build dependencies graph and improves build times by avoiding re-building unnecessary modules.
+Read [cache guide](src/site/markdown/cache.md) for more details.
+
+Building
+--------
+The code currently relies on un-released modifications in the core Maven project.  Two submodules are included in this git repository to allow building the needed distributions and perform integration tests using those.
+
+In order to build those distributions, you first need to launch once the `build-maven.sh` script or the following command in the `maven/maven3` and `maven/maven4` directories:
+```
+mvn install -DskipTests -P versionlessMavenDist
+```
+This will build the custom distributions of maven.
 
 License
 -------
diff --git a/run-its.sh b/build-maven.sh
similarity index 82%
rename from run-its.sh
rename to build-maven.sh
index 438c916..617e82d 100755
--- a/run-its.sh
+++ b/build-maven.sh
@@ -19,7 +19,5 @@
 # under the License.
 #
 
-# git submodule update --init --recursive
-
-mvn package -DskipTests -P versionlessMavenDist -f "maven/maven3" || exit $?
-mvn package -DskipTests -P versionlessMavenDist -f "maven/maven4" || exit $?
+mvn install -DskipTests -P versionlessMavenDist -f "maven/maven3" || exit $?
+mvn install -DskipTests -P versionlessMavenDist -f "maven/maven4" || exit $?
diff --git a/src/test/java/org/apache/maven/caching/its/junit/IntegrationTestExtension.java b/src/test/java/org/apache/maven/caching/its/junit/IntegrationTestExtension.java
index eed0507..bfae558 100644
--- a/src/test/java/org/apache/maven/caching/its/junit/IntegrationTestExtension.java
+++ b/src/test/java/org/apache/maven/caching/its/junit/IntegrationTestExtension.java
@@ -87,7 +87,7 @@ public class IntegrationTestExtension implements BeforeAllCallback, TestTemplate
         if ( !Files.exists( maven3Zip ) )
         {
             throw new IllegalStateException( "Unable to find " + maven3Zip + "\n"
-                    + "Please build the maven3 and maven4 distributions using the run-its.sh script" );
+                    + "Please build the maven3 and maven4 distributions using the build-maven.sh script" );
         }
         Path outMaven3 = Paths.get( "target/maven3" );
         deleteDir( outMaven3 );
@@ -101,7 +101,7 @@ public class IntegrationTestExtension implements BeforeAllCallback, TestTemplate
         if ( !Files.exists( maven4Zip ) )
         {
             throw new IllegalStateException( "Unable to find " + maven4Zip + "\n"
-                    + "Please build the maven3 and maven4 distributions using the run-its.sh script" );
+                    + "Please build the maven3 and maven4 distributions using the build-maven.sh script" );
         }
         Path outMaven4 = Paths.get( "target/maven4" );
         deleteDir( outMaven4 );