Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.adoc #281

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.adoc #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ After executing all tests, any failed tests are retried.
The process repeats with tests that continue to fail until the maximum specified number of retries has been attempted,
or there are no more failing tests.

By default, all failed tests passing on retry prevents the test task from failing.
This mode prevents _flaky_ tests from causing build failure.
By default, all failed tests passing on retry prevent the test task from failing.
This mode prevents _flaky_ tests from causing a build failure.
This setting can be changed so that flaky tests cause build failure, which can be used to identify flaky tests.

When something goes badly wrong and all tests start failing, it can be preferable to not keep retrying tests.
This can happen for example if a disk fills up or a required database is not available.
When something goes badly wrong, and all tests start failing, it can be preferable not to keep retrying tests.
This can happen, for example, if a disk fills up or a required database is not available.
To avoid this, the plugin can be configured to stop retrying after a certain number of total test failures.

**NOTE:** Retrying tests alone is not a viable flaky test mitigation strategy.
Expand Down Expand Up @@ -116,7 +116,7 @@ public interface TestRetryTaskExtension {
* <p>
* This setting has no effect if {@link Test#getIgnoreFailures()} is set to true.
*
* @return whether tests that initially fails and then pass on retry should fail the task
* @return whether tests that initially fail and then pass on retry should fail the task
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Can you please also fix the comment in the TestRetryTaskExtension.java class?

*/
Property<Boolean> getFailOnPassedAfterRetry();

Expand Down