Improved Documentation for "parallel" parameter value "none" #228
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added documentation to explicitly state that none can be used to disable parallel execution (e.g as an orverride).
|
@KyleRogers |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added documentation to explicitly state that "none" can be used to disable parallel execution. There was no documentation at the "parallel" parameter before that also listed this special value. The value "none" could only be retrieved from the implementation and is implicitly documented at the description of "parallelTestsTimeoutInSeconds" and "parallelTestsTimeoutForcedInSeconds" in SurefirePlugin.
Knowing a way to disable parallel execution is useful if you need to override a previously parallel exection. We usually declare our surefire tests to be executed in parallel. This is usually defined in the -Section of our parent pom.
Nevertheless when execting the tests with Coverage - JaCoCo in our case - the coverage data will be inaccurate if the tests are executed in parallel. JaCoCo even warns in those situations and sometimes even fails tests.
We use the value "none" to disable parallel test execution using a special "coverage" profile that also enables JaCoCo.