README.md in ci_reporter-2.0.0 vs README.md in ci_reporter-2.1.0
- old
+ new
@@ -3,12 +3,11 @@
runs. The resulting files can be read by a continuous integration
system that understands Ant's JUnit report XML format, thus allowing
your CI system to track test/spec successes and failures.
[](http://badge.fury.io/rb/ci_reporter)
-[](https://travis-ci.org/ci-reporter/ci_reporter)
-[](https://gemnasium.com/ci-reporter/ci_reporter)
+[](https://github.com/ci-reporter/ci_reporter/actions/workflows/ci.yaml)
[](https://codeclimate.com/github/ci-reporter/ci_reporter)
## Usage
CI::Reporter works with projects that use standard Rake tasks for
@@ -31,11 +30,11 @@
[ci-tu]: https://github.com/ci-reporter/ci_reporter_test_unit
### Upgrading from CI::Reporter 1.x
CI::Reporter 1.x supported all the different test frameworks in a
-single gem. This was convienient, but caused issues as test frameworks
+single gem. This was convenient, but caused issues as test frameworks
released new, sometimes incompatibile, versions. CI::Reporter 2.x has
been split into multiple gems, allowing each gem to specify the test
framework versions it supports.
To upgrade to 2.x, remove `ci_reporter` from your Gemfile and replace
@@ -44,11 +43,11 @@
## Jenkins setup
1. Add the "Publish JUnit test result report" post-build step
in the job configuration.
-2. Enter "test/reports/*.xml,spec/reports/*.xml" in the "Test report
+2. Enter "test/reports/\*.xml,spec/reports/\*.xml" in the "Test report
XMLs" field (adjust this to suit which tests you are running)
Report files are written, by default, to the
<code>test/reports</code>, <code>features/reports</code> or
<code>spec/reports</code> subdirectory of your project. If you wish
@@ -67,27 +66,27 @@
will be invoked:
```ruby
if ENV['GENERATE_REPORTS'] == 'true'
require 'ci/reporter/rake/rspec'
- task :rspec => 'ci:setup:rspec'
+ task :spec => 'ci:setup:rspec'
end
```
You can either inject this variable in your CI or simply call `rake`
with the environment variable set:
```
-GENERATE_REPORTS=true rake rspec
+GENERATE_REPORTS=true rake spec
```
### With CI-specific Rake tasks
Instead of modifying your existing Rake tasks, create new ones:
```ruby
namespace :ci do
- task :all => ['ci:setup:rspec', 'rspec']
+ task :all => ['ci:setup:rspec', 'spec']
end
```
Then use this Rake target in CI: