README.md in test_diff-0.4.2 vs README.md in test_diff-0.5.0
- old
+ new
@@ -20,11 +20,11 @@
$ bundle
## Rails Setup
-Suggest to disabled `eager_load` in `config/environments/test.rb` based on `ENV['TEST_DIFF_COVERAGE']`
+If `eager_load` is enabled in `config/environments/test.rb`, disable it based on `ENV['TEST_DIFF_COVERAGE']`
EG:
```ruby
config.eager_load = ENV['TEST_DIFF_COVERAGE'].blank?
```
@@ -39,18 +39,30 @@
end
```
## Usage
-Building the test coverage index
+Building the test coverage index (run once a day on your main branch)
- $ test_diff build_coverage spec spec/spec_helper.rb
+```bash
+ $ test_diff build_coverage spec/spec_helper.rb
$ # part here to upload test_diff_coverage to a shared space, ie aws
+```
-Running a test difference
+Running a test difference (after commit on your separate branch)
+```bash
$ # part here to download test_diff_coverage from shared space, ie aws
$ test_diff rspec
+```
+
+Updating the test coverage index (after separate branch merge into main branch)
+
+```bash
+ $ # part here to download test_diff_coverage from shared space, ie aws
+ $ test_diff build_coverage_diff spec/spec_helper.rb
+ $ # part here to upload test_diff_coverage to a shared space, ie aws
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.