README.md 816 Bytes
Newer Older
Marco Metz's avatar
Marco Metz committed
1
# CodeclimateReporter
2

Daniel Molnar's avatar
Daniel Molnar committed
3
4
Pushes a notification to the Dashboard app to notify that a cronjob occured.

5
6
7
8
9
10

## Installation

Add this line to your application's Gemfile:

```ruby
Marco Metz's avatar
Marco Metz committed
11
gem "codeclimate_reporter", git: "https://@git.ikusei.de/scm/ik/codeclimate-reporter.git"
12
13
14
15
```

And then execute:

Daniel Molnar's avatar
Daniel Molnar committed
16
17
18
```
$ bundle
```
19

Marco Metz's avatar
Marco Metz committed
20
21
22
23
24
25
26
27
28
29
Load gem on startup:

insert in `Rakefile` before `Rails.application.load_tasks`

```
require 'codeclimate_reporter'
spec = Gem::Specification.find_by_name 'codeclimate_reporter'
load "#{spec.gem_dir}/lib/tasks/codeclimate.rake"
```

Marco Metz's avatar
Marco Metz committed
30
31
32
33
34
35
36
37
38
Copy template file to project:

```ruby
rake codeclimate:install
```

Add credetnials to file `.codeclimate_reporter`


39
40
41
## Usage

```ruby
Marco Metz's avatar
Marco Metz committed
42
CodeclimateReporter::Branch.new.refresh
43
44
```

Marco Metz's avatar
Marco Metz committed
45
46
47
48
49
50
or as a rake task

```ruby
rake codeclimate:refresh
```

51
52
53
54

## Develop
```ruby
rake console
Daniel Molnar's avatar
Daniel Molnar committed
55
```