This is an automated email from the ASF dual-hosted git repository.
chia7712 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new bc3e6369b92 KAFKA-17931 Revise the `specifying-test-retries` section
in README (#17679)
bc3e6369b92 is described below
commit bc3e6369b92f9fac6bf45b9e81320758f0cc2750
Author: Ted Yan <[email protected]>
AuthorDate: Tue Nov 5 21:09:09 2024 -0600
KAFKA-17931 Revise the `specifying-test-retries` section in README (#17679)
Reviewers: Chia-Ping Tsai <[email protected]>
---
README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index b7221e12df8..c671e803ac8 100644
--- a/README.md
+++ b/README.md
@@ -62,15 +62,15 @@ to `log4j.logger.org.apache.kafka=INFO` and then run:
And you should see `INFO` level logs in the file under the
`clients/build/test-results/test` directory.
### Specifying test retries ###
-By default, each failed test is retried once up to a maximum of three total
retries per test run.
-Tests are retried at the end of the test task. Adjust these parameters in the
following way:
+Retries are disabled by default, but you can set maxTestRetryFailures and
maxTestRetries to enable retries.
+
+The following example declares -PmaxTestRetries=1 and -PmaxTestRetryFailures=3
to enable a failed test to be retried once, with a total retry limit of 3.
./gradlew test -PmaxTestRetries=1 -PmaxTestRetryFailures=3
-Additionally, quarantined tests are automatically retried three times up to a
total of
-20 retries per run. This is controlled by similar parameters.
+The quarantinedTest task also has no retries by default, but you can set
maxQuarantineTestRetries and maxQuarantineTestRetryFailures to enable retries,
similar to the test task.
- ./gradlew test -PmaxQuarantineTestRetries=3
-PmaxQuarantineTestRetryFailures=20
+ ./gradlew quarantinedTest -PmaxQuarantineTestRetries=3
-PmaxQuarantineTestRetryFailures=20
See [Test Retry Gradle
Plugin](https://github.com/gradle/test-retry-gradle-plugin) for and
[build.yml](.github/workflows/build.yml) more details.
