whelton / codecov-ruby

Ruby uploader for Codecov

codecov-ruby

Usage

Add to your Gemfile

gem 'codecov', :require => false, :group => :test

Add to the top of your tests/helper.rb file

require 'simplecov'
SimpleCov.start

require 'codecov'
SimpleCov.formatter = SimpleCov::Formatter::Codecov

In your CI Environment Variables (not needed for https://travis-ci.org/)

CODECOV_TOKEN="your repo token"

Find you repo token on your repo page at codecov.io. Repo tokens are not required for public repos on Travis-Ci, CircleCI, or AppVeyor CI.

Submit only in CI example

if ENV['CI'] == 'true'
  require 'codecov'
  SimpleCov.formatter = SimpleCov::Formatter::Codecov
end

CI Companies Supported

Jenkins, Travis CI, Codeship, Circle CI, Semaphore, drone.io, AppVeyor, Wercker, Magnum, Shippable, Gitlab CI, and Buildkite. Otherwise fallbacks on git.

Caveat

1. There are known issues when Simplecov.track_files is enabled. We recommend that you require all code files in your tests so that Simplecov can provide Codecov with properly mapped coverage report metrics. codecov/support#133

• https://github.com/colszowka/simplecov/blob/master/README.md#default-root-filter-and-coverage-for-things-outside-of-it

Enterprise

For companies using Codecov Enterprise you will need to specify the following parameters.

CODECOV_URL="https://codecov.mycompany.com"
CODECOV_SLUG="owner/repo"
CODECOV_TOKEN="repository token or global token"