mirror of
https://github.com/microsoft/playwright.git
synced 2024-09-11 20:37:54 +03:00
docs: clarify default retry behavior (#9525)
This commit is contained in:
parent
c711fb35ad
commit
4680ef46de
@ -16,7 +16,7 @@ These options define your test suite:
|
||||
- `name: string` - Project name, useful when defining multiple [test projects](#projects).
|
||||
- `outputDir: string` - Output directory for files created during the test run.
|
||||
- `repeatEach: number` - The number of times to repeat each test, useful for debugging flaky tests.
|
||||
- `retries: number` - The maximum number of retry attempts given to failed tests.
|
||||
- `retries: number` - The maximum number of retry attempts given to failed tests. If not specified, failing tests are not reried.
|
||||
- `testDir: string` - Directory that will be recursively scanned for test files.
|
||||
- `testIgnore: string | RegExp | (string | RegExp)[]` - Files matching one of these patterns are not considered test files.
|
||||
- `testMatch: string | RegExp | (string | RegExp)[]` - Only the files matching one of these patterns are considered test files.
|
||||
|
@ -219,7 +219,7 @@ Tests that took more than `threshold` milliseconds are considered slow, and the
|
||||
## property: TestConfig.retries
|
||||
- type: <[int]>
|
||||
|
||||
The maximum number of retry attempts given to failed tests. Learn more about [test retries](./test-retries.md#retries).
|
||||
The maximum number of retry attempts given to failed tests. By default failing tests are not reried. Learn more about [test retries](./test-retries.md#retries).
|
||||
|
||||
## property: TestConfig.shard
|
||||
- type: <[Object]>
|
||||
|
@ -56,7 +56,7 @@ This scheme works perfectly for independent tests and guarantees that failing te
|
||||
|
||||
## Retries
|
||||
|
||||
Playwright Test supports **test retries**. When enabled, failing tests will be retried multiple times until they pass, or until the maximum number of retries is reached.
|
||||
Playwright Test supports **test retries**. When enabled, failing tests will be retried multiple times until they pass, or until the maximum number of retries is reached. By default failing tests are not retried.
|
||||
|
||||
```bash
|
||||
# Give failing tests 3 retry attempts
|
||||
|
3
packages/playwright-test/types/test.d.ts
vendored
3
packages/playwright-test/types/test.d.ts
vendored
@ -537,7 +537,8 @@ interface TestConfig {
|
||||
*/
|
||||
repeatEach?: number;
|
||||
/**
|
||||
* The maximum number of retry attempts given to failed tests. Learn more about [test retries](https://playwright.dev/docs/test-retries#retries).
|
||||
* The maximum number of retry attempts given to failed tests. By default failing tests are not reried. Learn more about
|
||||
* [test retries](https://playwright.dev/docs/test-retries#retries).
|
||||
*/
|
||||
retries?: number;
|
||||
/**
|
||||
|
Loading…
Reference in New Issue
Block a user