update description for seed option

Add details on how the seed, specified or not, is used by Jest internally. Closes #15060
jestjs · Aug 20, 2024 · cfbf3f3 · cfbf3f3
1 parent 1eca335
commit cfbf3f3
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/docs/CLI.md b/docs/CLI.md
@@ -407,6 +407,8 @@ jest --seed=1324
 
 If this option is not specified Jest will randomly generate the value. You can use the [`--showSeed`](#--showseed) flag to print the seed in the test report summary.
 
+Jest uses the seed internally for shuffling the order in which test suites are run. If the [`--randomize`](#--randomize) option is used, the seed is also used for shuffling the order of tests within each `describe` block. When dealing with flaky tests, rerunning with the same seed might help reproduce the failure.
+
 :::
 
 ### `--selectProjects <project1> ... <projectN>`

diff --git a/website/versioned_docs/version-29.4/CLI.md b/website/versioned_docs/version-29.4/CLI.md
@@ -358,6 +358,8 @@ jest --seed=1324
 
 If this option is not specified Jest will randomly generate the value. You can use the [`--showSeed`](#--showseed) flag to print the seed in the test report summary.
 
+Jest uses the seed internally for shuffling the order in which test suites are run. If the [`--randomize`](#--randomize) option is used, the seed is also used for shuffling the order of tests within each `describe` block. When dealing with flaky tests, rerunning with the same seed might help reproduce the failure.
+
 :::
 
 ### `--selectProjects <project1> ... <projectN>`

diff --git a/website/versioned_docs/version-29.5/CLI.md b/website/versioned_docs/version-29.5/CLI.md
@@ -378,6 +378,8 @@ jest --seed=1324
 
 If this option is not specified Jest will randomly generate the value. You can use the [`--showSeed`](#--showseed) flag to print the seed in the test report summary.
 
+Jest uses the seed internally for shuffling the order in which test suites are run. If the [`--randomize`](#--randomize) option is used, the seed is also used for shuffling the order of tests within each `describe` block. When dealing with flaky tests, rerunning with the same seed might help reproduce the failure.
+
 :::
 
 ### `--selectProjects <project1> ... <projectN>`

diff --git a/website/versioned_docs/version-29.6/CLI.md b/website/versioned_docs/version-29.6/CLI.md
@@ -410,6 +410,8 @@ jest --seed=1324
 
 If this option is not specified Jest will randomly generate the value. You can use the [`--showSeed`](#--showseed) flag to print the seed in the test report summary.
 
+Jest uses the seed internally for shuffling the order in which test suites are run. If the [`--randomize`](#--randomize) option is used, the seed is also used for shuffling the order of tests within each `describe` block. When dealing with flaky tests, rerunning with the same seed might help reproduce the failure.
+
 :::
 
 ### `--selectProjects <project1> ... <projectN>`

diff --git a/website/versioned_docs/version-29.7/CLI.md b/website/versioned_docs/version-29.7/CLI.md
@@ -410,6 +410,8 @@ jest --seed=1324
 
 If this option is not specified Jest will randomly generate the value. You can use the [`--showSeed`](#--showseed) flag to print the seed in the test report summary.
 
+Jest uses the seed internally for shuffling the order in which test suites are run. If the [`--randomize`](#--randomize) option is used, the seed is also used for shuffling the order of tests within each `describe` block. When dealing with flaky tests, rerunning with the same seed might help reproduce the failure.
+
 :::
 
 ### `--selectProjects <project1> ... <projectN>`
-Original file line number
+Diff line change
@@ Expand Up / @@ -407,6 +407,8 @@ jest --seed=1324 @@
     If this option is not specified Jest will randomly generate the value. You can use the [`--showSeed`](#--showseed) flag to print the seed in the test report summary.
+    Jest uses the seed internally for shuffling the order in which test suites are run. If the [`--randomize`](#--randomize) option is used, the seed is also used for shuffling the order of tests within each `describe` block. When dealing with flaky tests, rerunning with the same seed might help reproduce the failure.
     :::
     ### `--selectProjects <project1> ... <projectN>`
@@ Expand Down @@