https://github.com/sea-aye/look-out

Report stats to Sea Aye services from your ruby project. Look Out is In charge of the observation of the code for hazards.
https://github.com/sea-aye/look-out

code-quality continuous-integration gem reporter rspec ruby simplecov velocity

Last synced: 8 days ago
JSON representation

Report stats to Sea Aye services from your ruby project. Look Out is In charge of the observation of the code for hazards.

• Host: GitHub
• URL: https://github.com/sea-aye/look-out
• Owner: sea-aye
• License: mit
• Created: 2018-12-24T21:42:31.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T19:28:38.000Z (over 3 years ago)
• Last Synced: 2024-11-16T17:39:49.640Z (about 1 month ago)
• Topics: code-quality, continuous-integration, gem, reporter, rspec, ruby, simplecov, velocity
• Language: Ruby
• Homepage: https://www.sea-aye.com
• Size: 112 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Look Out

In charge of the observation of the code for hazards.

## Installation

Add this line to your application's Gemfile:

```ruby

group :development, :test do

    gem 'look_out', require: false

end

```

And then initialize:

```ruby

# spec/spec_helper.rb

require 'look_out'

LookOut.configure do |config|

  config.api_key = '123'

  config.user = `git config user.name`.chomp

end

```

Add to your `.rspec`

```

--require 'look_out/rspec/look_out_formatter'

--format LookOut::RSpec::LookOutFormatter

# Make sure you have a formatter after this one in your .rspec or there will

# be no output from your spec suite. For example:

--format doc

# or

--format progress

```

#### VCR

If you're using VCR it may raise an exception for an unexpected HTTP request. If

so you can ignore it with:

```

VCR.configure do |config|

  ...

  config.ignore_hosts 'api.sea-aye.com'

  ...

end

```

## Usage

Run specs just like normal!

If you're running your specs against merged code you can force reporting for the

correct sha by setting a special environment variable.

```

export GIT_COMMIT_SHA='the-real-sha-aavvcc'

```

## Contributing

Bug reports and pull requests are welcome!