This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-verifier.git
The following commit(s) were added to refs/heads/master by this push:
new 0cbeed0 [MSHARED-1128] Update documentation with new execute method
0cbeed0 is described below
commit 0cbeed0f809f9929e6a8be3b1fba4f49cc29801e
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Tue Sep 20 18:54:37 2022 +0200
[MSHARED-1128] Update documentation with new execute method
Co-authored-by: Konrad Windszus <k...@apache.org>
---
.../org/apache/maven/shared/verifier/Verifier.java | 16 ++++++++--------
src/site/markdown/getting-started.md | 18 ++++++++++++++----
2 files changed, 22 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/apache/maven/shared/verifier/Verifier.java
b/src/main/java/org/apache/maven/shared/verifier/Verifier.java
index d964139..018c4da 100644
--- a/src/main/java/org/apache/maven/shared/verifier/Verifier.java
+++ b/src/main/java/org/apache/maven/shared/verifier/Verifier.java
@@ -1128,14 +1128,14 @@ public class Verifier
/**
* Execute Maven.
+ *
+ * @deprecated will be removed.
* <p>
* For replacement please use:
* <pre>
* verifier.addCliArgument( "goal" );
* verifier.execute();
* </pre>
- *
- * @deprecated will be removed without replacement.
*/
@Deprecated
public void executeGoal( String goal )
@@ -1146,6 +1146,8 @@ public class Verifier
/**
* Execute Maven.
+ *
+ * @deprecated will be removed.
* <p>
* For replacement please use:
* <pre>
@@ -1154,8 +1156,6 @@ public class Verifier
* verifier.setEnvironmentVariable( "key2", "value2" );
* verifier.execute();
* </pre>
- *
- * @deprecated will be removed without replacement.
*/
public void executeGoal( String goal, Map<String, String> envVars )
throws VerificationException
@@ -1165,14 +1165,14 @@ public class Verifier
/**
* Execute Maven.
+ *
+ * @deprecated will be removed
* <p>
* For replacement please use:
* <pre>
* verifier.addCliArguments( "goal1", "goal2" );
* verifier.execute();
* </pre>
- *
- * @deprecated will be removed without replacement.
*/
public void executeGoals( List<String> goals )
throws VerificationException
@@ -1197,6 +1197,8 @@ public class Verifier
/**
* Execute Maven.
+ *
+ * @deprecated will be removed
* <p>
* For replacement please use:
* <pre>
@@ -1205,8 +1207,6 @@ public class Verifier
* verifier.setEnvironmentVariable( "key2", "value2" );
* verifier.execute();
* </pre>
- *
- * @deprecated will be removed without replacement.
*/
public void executeGoals( List<String> goals, Map<String, String> envVars )
throws VerificationException
diff --git a/src/site/markdown/getting-started.md
b/src/site/markdown/getting-started.md
index 7e77135..660102a 100644
--- a/src/site/markdown/getting-started.md
+++ b/src/site/markdown/getting-started.md
@@ -129,17 +129,27 @@ For the Context Class Loader case this would mean the
following dependencies are
## Run
-Calling `executeGoals` runs Maven with the given goals or phases and
optionally some additional environment variables. It throws a
`VerificationException` in case the execution is not successful (e.g. binary
not found or exit code > 0). It is either using a forked JVM or is executed in
the same JVM depending on the configuration.
+Calling `execute()` runs Maven with the given Verifier configuration, like CLI
arguments and environment variables.
+At least one CLI argument should be provided which specifies either the Maven
phase(s) and/or the goal(s) to execute
+unless project has a default goal.
+
+It throws a `VerificationException` in case the execution is not successful
(e.g. binary not found or exit code > 0).
+The method is using either a forked JVM or the same JVM for executing Maven
depending on the configuration.
```
-verifier.executeGoals( "package" );
+verifier.addCliArgument( "package" )
+verifier.execute();
```
## Verify
-After executing the Maven goals there are several methods starting with prefix
`verify` which allow you to check for the build result, check the log for
certain contents and the existence of generated artifacts.
+After calling `execute` one should call one or multiple of the methods
starting with prefix `verify` to
+* check for the build result
+* check the log for certain contents or
+* check for the existence of generated artifacts.
-The main method `verify(boolean)` takes into consideration a file named
`expected-results.txt` being located in the base directory. Each line consists
of a file path (optionally prefixed by `!`) and it is automatically verified
that the file exists or is missing (in case the path starts with `!`).
+The main method `verify(boolean)` takes into consideration a file named
`expected-results.txt` being located in the tested project's base directory.
+Each line consists of a file path (optionally prefixed by `!`) and it is
automatically verified that the file exists or is missing (in case the path
starts with `!`).
```
verifier.verify( true ); // if true, throws an exception in case of errors in
the build log
