codeclimate-test-reporter 1.0.0.pre.rc2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +49 -11
- data/lib/code_climate/test_reporter/formatter.rb +0 -1
- data/lib/code_climate/test_reporter/version.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5178637634549cf9582b2157406010d9be7b5fd2
|
|
4
|
+
data.tar.gz: 35d82de9aa353cf145183f4c612f7e1ee7f221ed
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e0689fc31b7bcb21b8bc7ce529c2dfb98c45d01596b04c16a1da5b9ed076297dcb2949bb9e3f4012e5bd97476b6d6cf4508f121e021c0bb8ba65535787f19ac6
|
|
7
|
+
data.tar.gz: 7565a72528d0493ed30dd29b3b4869050e5984ad04389a79e47ed87a6ec121f4c61a37b2c814017487b663b96d18e856b1ae5b848fc5f7c07b32a5967f86f0e4
|
data/README.md
CHANGED
|
@@ -2,35 +2,73 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://codeclimate.com/github/codeclimate/ruby-test-reporter)
|
|
4
4
|
|
|
5
|
-
Posts SimpleCov test coverage data from your Ruby test suite to Code Climate's
|
|
5
|
+
Posts SimpleCov test coverage data from your Ruby test suite to Code Climate's
|
|
6
|
+
hosted, automated code review service.
|
|
6
7
|
|
|
7
8
|
Code Climate - [https://codeclimate.com](https://codeclimate.com)
|
|
8
9
|
|
|
9
10
|
## Installation
|
|
10
11
|
|
|
11
|
-
This gem requires a user, but not necessarily a paid account, on Code Climate,
|
|
12
|
-
first step is to signup at:
|
|
12
|
+
This gem requires a user, but not necessarily a paid account, on Code Climate,
|
|
13
|
+
so if you don't have one the first step is to signup at:
|
|
14
|
+
[https://codeclimate.com](https://codeclimate.com). Then:
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
* Add this to your Gemfile:
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
```ruby
|
|
19
|
+
group :test do
|
|
20
|
+
gem "simplecov"
|
|
21
|
+
gem "codeclimate-test-reporter", "~> 1.0.0"
|
|
22
|
+
end
|
|
23
|
+
```
|
|
17
24
|
|
|
18
|
-
|
|
25
|
+
* Start SimpleCov as you normally would (more information here:
|
|
26
|
+
https://github.com/colszowka/simplecov)
|
|
27
|
+
* Set the `CODECLIMATE_REPO_TOKEN` environment variable (provided after you add
|
|
28
|
+
your repo to your Code Climate account by clicking on "Setup Test Coverage" on
|
|
29
|
+
the right hand side of your feed)
|
|
30
|
+
* Run the `codeclimate-test-reporter` executable after your test suite
|
|
19
31
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
32
|
+
```
|
|
33
|
+
bundle exec rake
|
|
34
|
+
bundle exec codeclimate-test-reporter
|
|
35
|
+
```
|
|
23
36
|
|
|
24
37
|
Please contact hello@codeclimate.com if you need any assistance setting this up.
|
|
25
38
|
|
|
26
39
|
## Troubleshooting / FYIs
|
|
27
40
|
|
|
28
|
-
Across the many different testing frameworks, setups, and environments, there
|
|
41
|
+
Across the many different testing frameworks, setups, and environments, there
|
|
42
|
+
are lots of variables at play. If you're having any trouble with your test
|
|
43
|
+
coverage reporting or the results are confusing, please see our full
|
|
44
|
+
documentation here: https://docs.codeclimate.com/docs/setting-up-test-coverage
|
|
45
|
+
|
|
46
|
+
## Upgrading from pre-1.0 Versions
|
|
47
|
+
|
|
48
|
+
Version `1.0` of the this gem introduces new, breaking changes to the way the
|
|
49
|
+
test reporter is meant to be executed. The following list summarizes the major
|
|
50
|
+
differences:
|
|
51
|
+
|
|
52
|
+
* Previously, this gem extended `Simplecov` with a custom formatter which posted
|
|
53
|
+
results to Code Climate. Now, you are responsible for executing `Simplecov`
|
|
54
|
+
yourself, and then running `codeclimate-test-reporter` as a separate step in
|
|
55
|
+
your build.
|
|
56
|
+
* Previously, this gem added some exclusion rules tuned according to feedback
|
|
57
|
+
from its users, and now these no longer happen automatically. *If you are
|
|
58
|
+
experiencing a discrepancy in test coverage % after switching to the new gem
|
|
59
|
+
version, it may be due to missing exclusions. Filtering `vendor`, `spec`, or
|
|
60
|
+
`test` directories may fix this issue.*
|
|
61
|
+
* Previously, during the execution of multiple test suites, this gem would send
|
|
62
|
+
results from the first suite completed. You are now expected to run an
|
|
63
|
+
executable packaged with this gem as a separate build step, which means that
|
|
64
|
+
whatever results are there (likely the results from the last suite) will be
|
|
65
|
+
posted to Code Climate.
|
|
29
66
|
|
|
30
67
|
## Contributions
|
|
31
68
|
|
|
32
69
|
Patches, bug fixes, feature requests, and pull requests are welcome on the
|
|
33
|
-
GitHub page for this project:
|
|
70
|
+
GitHub page for this project:
|
|
71
|
+
[https://github.com/codeclimate/ruby-test-reporter](https://github.com/codeclimate/ruby-test-reporter)
|
|
34
72
|
|
|
35
73
|
This gem is maintained by Bryan Helmkamp (bryan@codeclimate.com).
|
|
36
74
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: codeclimate-test-reporter
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.0
|
|
4
|
+
version: 1.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Bryan Helmkamp
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2016-
|
|
11
|
+
date: 2016-11-04 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: simplecov
|
|
@@ -137,12 +137,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
137
137
|
version: '1.9'
|
|
138
138
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
139
139
|
requirements:
|
|
140
|
-
- - "
|
|
140
|
+
- - ">="
|
|
141
141
|
- !ruby/object:Gem::Version
|
|
142
|
-
version:
|
|
142
|
+
version: '0'
|
|
143
143
|
requirements: []
|
|
144
144
|
rubyforge_project:
|
|
145
|
-
rubygems_version: 2.
|
|
145
|
+
rubygems_version: 2.5.1
|
|
146
146
|
signing_key:
|
|
147
147
|
specification_version: 4
|
|
148
148
|
summary: Uploads Ruby test coverage data to Code Climate.
|