You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/01/16 14:11:39 UTC

[maven-integration-testing] branch master updated: fix links (apt, not markdown), better split ITs vs support vs suite

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

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-integration-testing.git


The following commit(s) were added to refs/heads/master by this push:
     new ddc2401  fix links (apt, not markdown), better split ITs vs support vs suite
ddc2401 is described below

commit ddc2401836fa2115e46f9e56c1edfc7a1415658d
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Jan 16 15:11:36 2022 +0100

    fix links (apt, not markdown), better split ITs vs support vs suite
---
 core-it-suite/src/site/apt/bootstrap.apt.vm |  5 ++--
 core-it-suite/src/site/apt/index.apt.vm     | 35 ------------------------
 src/site/apt/index.apt                      | 42 ++++++++++++++++++++++++++---
 3 files changed, 42 insertions(+), 40 deletions(-)

diff --git a/core-it-suite/src/site/apt/bootstrap.apt.vm b/core-it-suite/src/site/apt/bootstrap.apt.vm
index 242eaaf..50c48b9 100644
--- a/core-it-suite/src/site/apt/bootstrap.apt.vm
+++ b/core-it-suite/src/site/apt/bootstrap.apt.vm
@@ -29,8 +29,9 @@
 Maven Core Integration Tests Bootstrap
 
   Core IT Bootstrapping downloads from Central repository every dependency (artifacts, plugins) required to let
-  Core ITs Suite run without downloading anything later (see {{{./index.html}Core ITs Suite and dependencies}} rationale),
-  as defined in [a series of bootstrap projects](https://github.com/apache/maven-integration-testing/tree/master/core-it-suite/src/test/resources/bootstrap):
+  Core ITs Suite run without downloading anything later (see {{{./index.html#Core_ITs_Suite_and_Dependencies}Core ITs Suite and dependencies}} rationale).
+  
+  Content to download is defined in {{{https://github.com/apache/maven-integration-testing/tree/master/core-it-suite/src/test/resources/bootstrap}a series of bootstrap projects}}:
 
 %{toc|section=1|fromDepth=2}
 
diff --git a/core-it-suite/src/site/apt/index.apt.vm b/core-it-suite/src/site/apt/index.apt.vm
index 4d8af2a..e21eb07 100644
--- a/core-it-suite/src/site/apt/index.apt.vm
+++ b/core-it-suite/src/site/apt/index.apt.vm
@@ -31,41 +31,6 @@ Maven Core Integration Tests Suite
   This module provides the {{{./testapidocs/org/apache/maven/it/package-summary.html}effective Core Integration Tests suite}},
   starting with {{{./bootstrap.html}bootstrap}}.
 
-* Running the Core ITs
-
-  By default, the project just packages the tests in an artifact. To actually run them, activate the <<<run-its>>> profile:
-  
-+----
-mvn clean test -Prun-its
-+----
-  
-  This will subject the Maven version running the build to the integration tests.
-  
-  If you would like to test a different Maven distribution, you can use the <<<mavenHome>>> system property to specify the
-  path of the Maven distribution to test:
-  
-+----
-mvn clean test -Prun-its -DmavenHome=<maven-under-test>
-+----
-  
-  Alternatively, you can just specify the version of a previously installed/deployed Maven distribution which will be
-  downloaded, unpacked and tested:
-  
-+----
-mvn clean test -Prun-its -DmavenVersion=2.2.1
-+----
-  
-  To run the ITs using embedded Maven 3.x, additionally activate the <<<embedded>>> profile.
-  
-  ITs that don't require to fork Maven can also be run from the IDE using the Maven projects from the workspace if the
-  Maven dependencies are added to the test class path.
-  
-  If you're behind a proxy, use the system properties <<<proxy.host>>>, <<<proxy.port>>>, <<<proxy.user>>>, <<<proxy.pass>>>
-  and <<<proxy.nonProxyHosts>>> to specify the required proxy setup for the ITs. Alternatively, set the system property
-  <<<maven.it.central>>> to a URL of a local repository manager (anonymous authentication only) that proxies the required
-  artifacts.
-
-
 * Core ITs Suite Results
 
   ITs results are displayed on the console and can be published in the site through Surefire Report.
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index 0917468..239eab0 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -31,8 +31,44 @@ Maven Core ITs
 
  Maven Core Integration Tests provide tooling to test every aspect of Maven functionalities with any Maven version.
 
- This project has declared the following modules:
+ This project is split in 2 modules:
 
- * {{{./core-it-support/}Maven Core IT Support}}: Maven Integration Tests support tools, to completely decouple ITs from production plugins.
+ * {{{./core-it-support/}Maven Core IT Support}}: Maven Integration Tests support tools, to completely decouple ITs from production plugins,
 
- * {{{./core-it-suite/}Maven Core ITs suite}}: The effective Maven Integration Tests suite.
+ * {{{./core-it-suite/}Maven Core ITs suite}}: The effective Maven Integration Tests suite, providing the interesting {{{./core-it-suite/surefire-report.html}tests results}}.
+
+
+* Running the Core ITs
+
+  By default, the project just packages the tests in an artifact. To actually run them, activate the <<<run-its>>> profile:
+  
++----
+mvn clean test -Prun-its
++----
+  
+  This will subject the Maven version running the build to the integration tests.
+  
+  If you would like to test a different Maven distribution, you can use the <<<mavenHome>>> system property to specify the
+  path of the Maven distribution to test:
+  
++----
+mvn clean test -Prun-its -DmavenHome=<maven-under-test>
++----
+  
+  Alternatively, you can just specify the version of a previously installed/deployed Maven distribution which will be
+  downloaded, unpacked and tested:
+  
++----
+mvn clean test -Prun-its -DmavenVersion=2.2.1
++----
+  
+  To run the ITs using embedded Maven 3.x, additionally activate the <<<embedded>>> profile.
+  
+  ITs that don't require to fork Maven can also be run from the IDE using the Maven projects from the workspace if the
+  Maven dependencies are added to the test class path.
+  
+  If you're behind a proxy, use the system properties <<<proxy.host>>>, <<<proxy.port>>>, <<<proxy.user>>>, <<<proxy.pass>>>
+  and <<<proxy.nonProxyHosts>>> to specify the required proxy setup for the ITs. Alternatively, set the system property
+  <<<maven.it.central>>> to a URL of a local repository manager (anonymous authentication only) that proxies the required
+  artifacts.
+ 
\ No newline at end of file