docs: document that havoc should not be used in CI/CD

lucgagan · Nov 12, 2023 · 4d6a880 · 4d6a880
1 parent 12b36da
commit 4d6a880
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,8 @@ test.beforeEach(async ({ page }) => {
 });
 ```
 
+> **Note:** `havoc` must be used only while troubleshooting or trying to identify flaky tests. It must not be used in your CI/CD pipeline as it will cause your tests to run a lot longer than needed.
+
 ## How does it work?
 
 In short, it is designed to cause havoc in your test suite. It does this by intercepting and randomly modifying HTTP response times. It then analyzes the results to determine if any tests are flaky.