If you’re new to Coveralls, we recommend starting with our Getting Started guide.
If you already know why you need an integration to start using Coveralls, and want to choose the best one for your use case, you’re in the right place.
We’ve been around since 2011 and, as a result, many Coveralls integrations exist for many different use cases.
Once you’ve chosen your integration, you’ll need to configure it to work with your CI service. See Configuring Your Coveralls Integration, below, to learn more.
These Coveralls integrations are built and maintained by the community associated with a particular programming language.
Most are tried and true, so if you find one for your language that looks stable and well-maintained, it’s often a great choice, particularly for getting up and running quickly in a context of familiar libraries and tools.
Click to see the integrations available for each of these languages / frameworks:
These integrations are built and maintained by Coveralls, and are offered as extensions to popular CI services:
The Coveralls Universal Coverage Reporter
It’s a command line tool that can be used to detect and upload coverage reports from almost any environment. As a result, it’s among your most flexible integration options, but it does currently require comfort with the command line and utilities like
|Note: Soon, we'll be releasing new versions of our Github Action (v2) and Orb that will use the Universal Coverage Reporter as their underlying integration. In each of these cases, users will benefit from the power of this integration with ease-of-user of the configuration-as-code setup philosophy of those extensions.|
The chief benefit of many of the Language Integrations referenced above is that they were built around the leading coverage report format of a particular programming language.
At this time, the Universal Coverage Reporter supports these coverage report formats.
We are looking for contributors to help us add support for more formats and widen its application to more use cases.
We’re also looking for help adding support for more CI services and environments.
If you’re interested in contributing to the Universal Coverage Reporter, please see our Developer Guide.
If you’re interested in receiving a bounty for your contribution in the form of one or more months of free service at Coveralls.io, please reach out to us.
For general support with choosing and configuring your Coveralls Integration, please see our Getting Started guide. It walks you through this whole process from scratch.
Regardless of which Coveralls Integration you choose, you’ll need to follow its README to learn how to configure it to work with your CI Service.
In doing so, it’s helpful to understand this:
Coveralls was designed to work with all CI services.
Many integrations officially support multiple CI services, which means they will automatically detect your CI service and configure themselves accordingly.
If you discover that your chosen integration does not officially support your CI service, all is not lost. You can still use it by configuring it manually.
One important manual configuration requirement for all Coveralls Integrations is your Coveralls Repo Token.*
When you add a new repo to Coveralls, Coveralls generates a Coveralls Repo Token for it and displays it prominently in the Coveralls UI for you to grab and use in your setup process:
Repo token callout on the Repo Start Page.
You can read more about the Coveralls Repo Token—what is it, how it works, where to find it, and how to set it—here.
* Note: It doesn’t matter which CI Service you’re using, or whether it is manually or automatically configured. You must provide this this variable somewhere in your environment so it’s available to your integration at build time.
Any problems, questions or comments about this doc? Let us know.