From 4680ef46de8a40aa7aae2a76dd5efc464548988c Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Thu, 14 Oct 2021 19:28:47 -0700 Subject: [PATCH] docs: clarify default retry behavior (#9525) --- docs/src/test-advanced-js.md | 2 +- docs/src/test-api/class-testconfig.md | 2 +- docs/src/test-retries-js.md | 2 +- packages/playwright-test/types/test.d.ts | 3 ++- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/src/test-advanced-js.md b/docs/src/test-advanced-js.md index 2845d4573f..e357b0e92b 100644 --- a/docs/src/test-advanced-js.md +++ b/docs/src/test-advanced-js.md @@ -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. diff --git a/docs/src/test-api/class-testconfig.md b/docs/src/test-api/class-testconfig.md index a86723131e..07616906cf 100644 --- a/docs/src/test-api/class-testconfig.md +++ b/docs/src/test-api/class-testconfig.md @@ -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]> diff --git a/docs/src/test-retries-js.md b/docs/src/test-retries-js.md index 5c22faa629..c10fb9e46d 100644 --- a/docs/src/test-retries-js.md +++ b/docs/src/test-retries-js.md @@ -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 diff --git a/packages/playwright-test/types/test.d.ts b/packages/playwright-test/types/test.d.ts index 64a4b8173c..0f144b83e8 100644 --- a/packages/playwright-test/types/test.d.ts +++ b/packages/playwright-test/types/test.d.ts @@ -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; /**