josegonzalez/orb

This repository provides a CircleCI Orb for Coveralls, which is a packaged integration that connects two services: CircleCI (a tool that automatically builds and tests your code every time you push changes) and Coveralls (a service that tracks how much of your code is covered by tests). The orb acts as a bridge, automatically sending your test coverage data from CircleCI to Coveralls without you needing to write custom scripts to handle that transfer. To use it, you add a couple of lines to your CircleCI configuration file that reference the orb. After your test suite runs and generates coverage data, the orb's single command, coveralls/upload, sends that data to your Coveralls account. The README includes a second example for parallel builds, where your tests run across multiple jobs at once. In that scenario, each job uploads its own partial coverage data, and a final job tells Coveralls to combine everything together. This tool is for teams already using both CircleCI and Coveralls. For example, a startup with a Node.js app that runs tests on every pull request could use this orb to automatically see whether new code is well-tested before merging it into the main branch. A technical founder or PM reviewing a pull request could check the Coveralls dashboard to confirm coverage percentages without anyone manually running a report. One thing worth noting is that the setup requires enabling specific settings in CircleCI, including allowing "uncertified orbs" and enabling beta pipeline features. This means there are some organizational-level security settings that need to be turned on before the integration will work. Beyond that, the README doesn't go into detail about supported coverage file formats, pointing instead to a separate project for that information.