README.md in rspec-tracer-0.9.3 vs README.md in rspec-tracer-1.0.0
- old
+ new
@@ -1,7 +1,8 @@

+[](https://discord.gg/H2G9yWeuRZ)
[](https://codeclimate.com/github/avmnu-sng/rspec-tracer/maintainability)
[](https://codeclimate.com/github/avmnu-sng/rspec-tracer/test_coverage)
[](https://badge.fury.io/rb/rspec-tracer)
RSpec Tracer is a **specs dependency analyzer**, **flaky tests detector**, **tests accelerator**,
@@ -32,10 +33,12 @@
## Table of Contents
* [Demo](#demo)
* [Getting Started](#getting-started)
+ * [Working with JRuby](#working-with-jruby)
+ * [Working with Parallel Tests](#working-with-parallel-tests)
* [Configuring CI Caching](#configuring-ci-caching)
* [Advanced Configuration](#advanced-configuration)
* [Filters](#filters)
* [Environment Variables](#environment-variables)
* [Duplicate Examples](#duplicate-examples)
@@ -133,10 +136,32 @@
coverage results even when enabled**.
3. After running your tests, open `rspec_tracer_report/index.html` in the browser
of your choice.
+### Working with JRuby
+
+It is recommend to use **JRuby 9.2.10.0+**. Also, configure it with **`JRUBY_OPTS="--debug -X+O"`**
+or have the `.jrubyrc` file:
+
+```ruby
+debug.fullTrace=true
+objectspace.enabled=true
+```
+
+### Working with Parallel Tests
+
+The Rspec tracer, by default, supports working with [parallel_tests](https://github.com/grosser/parallel_tests/)
+gem. It maintains a lock file `/tmp/parallel_tests.lock` to identify the last
+running process. Usually, you are not required to do anything special unless you
+interrupt the execution in between and the process did not complete correctly.
+In such a case, you must delete the lock file before the next run.
+
+```sh
+rm -f /tmp/parallel_tests.lock && bundle exec parallel_rspec
+```
+
## Configuring CI Caching
To enable RSpec Tracer to share cache between different builds on CI, update the
Rakefile in your project to have the following:
```ruby
@@ -226,14 +251,14 @@
```sh
export RSPEC_TRACER_CACHE_DIR=/tmp/rspec_tracer_cache
```
- **`RSPEC_TRACER_COVERAGE_DIR`** to update the default coverage directory (`rspec_tracer_coverage`).
```sh
- export RSPEC_TRACER_CACHE_DIR=/tmp/rspec_tracer_coverage
+ export RSPEC_TRACER_COVERAGE_DIR=/tmp/rspec_tracer_coverage
```
- **`RSPEC_TRACER_REPORT_DIR`** to update the default html reports directory (`rspec_tracer_report`).
```sh
- export RSPEC_TRACER_CACHE_DIR=/tmp/rspec_tracer_report
+ export RSPEC_TRACER_REPORT_DIR=/tmp/rspec_tracer_report
```
These settings are available through environment variables because the rake tasks
to download and upload the cache files need to use the same directories.