kwin commented on code in PR #49: URL: https://github.com/apache/maven-verifier/pull/49#discussion_r975645995
########## src/site/markdown/getting-started.md: ########## @@ -129,17 +129,24 @@ 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, environment variables. +We must provide at lease one cli argument for executing. Review Comment: ```suggestion At least one CLI argument must be given which specifies either the Maven phase(s) and/or the goal(s) to execute. ``` ########## src/site/markdown/getting-started.md: ########## @@ -129,17 +129,24 @@ 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, environment variables. +We must provide at lease one cli argument for executing. + +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. Review Comment: ```suggestion The method is using either a forked JVM or the same JVM for executing Maven depending on the configuration. ``` ########## src/site/markdown/getting-started.md: ########## @@ -129,17 +129,24 @@ 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, environment variables. +We must provide at lease one cli argument for executing. + +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. ``` -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 executing the Maven process there are several methods starting with prefix `verify` Review Comment: ```suggestion After calling `execute` one should call one or multiple of the methods starting with prefix `verify` to ``` ########## src/site/markdown/getting-started.md: ########## @@ -129,17 +129,24 @@ 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, environment variables. +We must provide at lease one cli argument for executing. + +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. ``` -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 executing the Maven process 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. -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 base directory. Review Comment: ```suggestion The main method `verify(boolean)` takes into consideration a file named `expected-results.txt` being located in the tested project's base directory. ``` ########## src/site/markdown/getting-started.md: ########## @@ -129,17 +129,24 @@ 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, environment variables. +We must provide at lease one cli argument for executing. + +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. ``` -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 executing the Maven process 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. Review Comment: ```suggestion * check for the build result * check the log for certain contents or * check for the existence of generated artifacts. ``` ########## src/site/markdown/getting-started.md: ########## @@ -129,17 +129,24 @@ 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, environment variables. Review Comment: ```suggestion Calling `execute` runs Maven with the given Verifier configuration like CLI arguments and environment variables. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
