README.md in knapsack_pro-1.20.1 vs README.md in knapsack_pro-1.20.2
- old
+ new
@@ -595,21 +595,21 @@
* Minitest
* Cucumber
## Split test files by test cases
-__Note:__ this is an experimental feature. It works for Regular Mode and Queue Mode. For large test suite with a few thousand test files, it may generate too many RSpec test example paths that may lead to too large JSON payload in request to Knapsack Pro API and this could trigger the API timeout.
+> __Note:__ this is an experimental feature. It works for Regular Mode and Queue Mode. For large test suite with a few thousand test files, it may generate too many RSpec test example paths that may lead to too large JSON payload in request to Knapsack Pro API and this could trigger the API timeout.
+>
+> Please give us feedback so we could improve the feature.
+> https://knapsackpro.com/contact
-Please give us feedback so we could improve the feature.
-https://knapsackpro.com/contact
-
__How it works__: You can split slow test file by test cases. Thanks to that the test file can be split across parallel CI nodes because test cases from the test file will run on different CI nodes.
This is helpful when you have one or a few very slow test files that are a bottleneck for CI build speed and you don't want to manually create a few smaller test files from the slow test files. Instead, you can tell `knapsack_pro` gem to split your test files by test cases across parallel CI nodes.
### RSpec split test files by test examples (by individual `it`s)
-__Requirement:__ It works with >= RSpec 3.6.0.
+> ❗ __WARNING (known issues):__ This is an experimental feature. We detected edge cases for Queue Mode when test examples might be ignored by RSpec and won't run test. Do not use this feature for production yet. We'll appreciate your [feedback](https://knapsackpro.com/contact) how it works while you test it on a separate branch. We work on improvements.
In order to split RSpec test files by test examples across parallel CI nodes you need to set environment variable:
```
KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true