blackcandy-org / blackcandy

Start Uploading Coverage

Setup instructions for this Ruby project:

STEP 1: CHOOSE AN INTEGRATION

Several options here. To pick an integration:

OPTION 1: Go to Coveralls Integrations and find a community-created integration for your programming language.

The main language of this project appears to be: Ruby
Ruby integrations for Coveralls can be found here.
We recommend: coveralls-ruby-reborn

OPTION 2: Choose one of these extensions for popular CI services:

Github Actions: Coveralls Github Action
CircleCI: Coveralls Orb for CircleCI

OPTION 3: Try our new Universal Coverage Reporter:

It's a cross-platform binary that runs on Linux, MacOS and Windows
It currently supports these coverage report formats and these CI services.
It represents our future direction for a single Coveralls integration for all projects.
If you'd like to contribute to the Universal Coverage Reporter, see its developer notes or get in touch for more info.

Tip: Read more about why you might want to choose one of these options over another, here.

STEP 2: CONFIGURE YOUR PROJECT TO SEND COVERAGE TO COVERALLS

Follow the README for your chosen integration to accomplish two tasks:

Install the integration into your project.
Add code to your CI build script to run your tests and upload coverage reports to Coveralls.

YOUR COVERALLS REPO TOKEN:

As part of this step, you’ll want to create a secure CI environment variable (or secret) called COVERALLS_REPO_TOKEN to hold your Coveralls Repo Token:

COVERALLS_REPO_TOKEN=z1eZzmdeUew7I24qLNpyVtnTtrocvMleO

This token identifies this repo to the Coveralls API and prevents unauthorized coverage reports.

STEP 3: COMMIT CODE AND VIEW COVERAGE REPORTS

If all went well with configuration, Coveralls is ready to track coverage for every new build of your project in CI.

To verify:

Commit some code to your repo to trigger CI to run tests and send your first coverage report to Coveralls.
If that succeeds, this page will be replaced with your first coverage report for blackcandy-org/blackcandy!

Note: To see your first coverage report here, you can either watch your CI build log and follow the URL returned with any 200 Success response from the Coveralls API, or simply wait until your CI build finishes and refresh this page.

Tip: Take a quick tour of the Coveralls UI to familiarize yourself with its features.

QUESTIONS? PROBLEMS?

For issues, check out: Common Issues & Troubleshooting.
For more advanced concerns, check out: Where To Go From Here.
For general questions, check out the FAQ.
If you're stuck: Get in touch and we'll help you out.

And you can't go wrong by checking out the docs:

Documentation