COVERALLS(1)

📦
version 0.8.23 · 5 versions
, in debian bookworm, ubuntu noble

💖 COVERALLS(1) 💖

okay bestie, welcome to the coveralls manual page — it's a General Commands Manual situation, and we're gonna get you fluent in it. sit down, grab a strawberry, let's go 🍓

✨ NAME ✨

coveralls — Coveralls API client utility. yes that's the whole vibe, it's a little command-line bestie that talks to Coveralls for you 🫶

🌸 SYNOPSIS 🌸

coveralls sub-command

that's it. that's the whole shape of it. you give it a sub-command and it does the thing 💅

💜 DESCRIPTION 💜

okay so Coveralls is a command-line utility that lets you hang out with the Coveralls web service, and its whole thing is helping you track your code coverage over time and making sure all your new code is fully covered. no half-covered new code allowed, that's the rule ✨

Here's the magic: Coveralls automatically collects your code coverage data, uploads it to their servers, and then gives you a genuinely nice interface to dig into it. like, you don't have to do the collecting, it just happens. obsessed 😌

And the good news for the Ruby girlies: any type of Ruby project or test framework supported by SimpleCov is supported by the Coveralls gem. that includes all your faves, like RSpec, Cucumber, and Test::Unit. so whatever you're already running, you're probably covered 💖

👑 SUB-COMMANDS 👑

  • help COMMAND — describes the available commands, or, if you pass a COMMAND, describes that one specific command. your little built-in cheat sheet 📖
  • last — view the last build for this repository on Coveralls. peek at your most recent run 👀
  • open — view this repository on Coveralls. opens the repo page so you don't have to go find it yourself 🦋
  • push — runs your test suite and pushes the coverage results to Coveralls. the main character command, honestly 🔥
  • report — runs your test suite locally and displays coverage statistics. no uploading, just you and the numbers, being cozy at home 🎀
  • service — view this repository on your CI service's website. hop over to CI-land 🌈
  • version — see version. (yes that's literally what it says, bestie, it's very self-explanatory 💀)

🧚 CONFIGURATION 🧚

Coveralls for Ruby uses an optional .coveralls.yml file at the root level of your repository to configure options. optional, so if you don't need it, don't make it 💅

The option repo_token (you'll find it on your repository's page on Coveralls) is how you specify which project on Coveralls your project maps to. Important detail: this is only needed for repos not using a CI, and it should be kept secret — anyone could use it to submit coverage data on your repo's behalf. that's a whole lot of power in one little token 😭

That said — this shouldn't be a concern for private repos, so if yours is private, breathe, you're fine 🫶

Another important option is service_name, which lets you specify where Coveralls should look to find additional information about your builds. It can be any string, but using travis-ci or travis-pro will let Coveralls fetch branch data, comment on pull requests, and more. so like, technically anything works, but those two unlock the fun stuff ✨

💖 FILES 💖

  • .coveralls.yml — Coveralls configuration file for Ruby. See CONFIGURATION above, bestie, it's all there 💜

🌟 SEE ALSO 🌟

For more information, you may visit the Coveralls web site: https://coveralls.io/ or https://coveralls.io/docs/ruby.

This manual page was generated from Markdown with ronn(1) — http://rtomayko.github.com/ronn/ronn.1.html ✨

🎀 AUTHOR 🎀

Coveralls was written by Wil Gieseler supapuerco@gmail.com, with contributions from the community. shoutout to everyone who pitched in 🫶

🌸 DOCUMENTATION 🌸

This manual page was written by Miguel Landaeta nomadium@debian.org. iconic behavior, thank you for your service 💅

🔥 LICENSE 🔥

Both Coveralls and this documentation are released under the terms of the MIT License. You may view the license online:

https://github.com/lemurheavy/coveralls-ruby/blob/master/LICENSE

and that's the whole page, bestie 💖 this one's from December 2022, straight out of the COVERALLS(1) zone — go forth and get those coverage numbers up, you've absolutely got this 👑✨

📦 where this page comes from