Skip to content

Commit

Permalink
improve instructions for runtime logger
Browse files Browse the repository at this point in the history
  • Loading branch information
grosser committed Oct 9, 2023
1 parent 370add9 commit ea63f45
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions Readme.md
Expand Up @@ -106,11 +106,13 @@ at_exit do
end
```

Even test group run-times
=========================
Even test group runtimes
========================

Test groups are often not balanced and will run for different times, making everything wait for the slowest group.
Use these loggers to record test runtime and then use the recorded runtime to balance test groups more evenly.
Test groups will often run for different times, making the full test run as slow as the slowest group.

Step 1: Use these loggers (see below) to record test runtime
Step 2: Your next run will use the recorded test runtimes (use `--runtime-log <file>` if you picked a location different from below)

### RSpec

Expand All @@ -128,9 +130,11 @@ Add to your `test_helper.rb`:
require 'parallel_tests/test/runtime_logger' if ENV['RECORD_RUNTIME']
```

results will be logged to tmp/parallel_runtime_test.log when `RECORD_RUNTIME` is set,
results will be logged to `tmp/parallel_runtime_test.log` when `RECORD_RUNTIME` is set,
so it is not always required or overwritten.

### TODO: add instructions for other frameworks

Loggers
=======

Expand Down

0 comments on commit ea63f45

Please sign in to comment.