https://github.com/codacy/codacy-coverage-reporter

Multi-language coverage reporter for Codacy
https://github.com/codacy/codacy-coverage-reporter

codacy codacy-coverage-reporter coverage coverage-report coverage-reports reporter

Last synced: about 3 hours ago
JSON representation

Multi-language coverage reporter for Codacy

• Host: GitHub
• URL: https://github.com/codacy/codacy-coverage-reporter
• Owner: codacy
• License: other
• Created: 2015-04-27T10:26:46.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-01-15T12:07:07.000Z (4 days ago)
• Last Synced: 2025-01-15T21:14:03.097Z (3 days ago)
• Topics: codacy, codacy-coverage-reporter, coverage, coverage-report, coverage-reports, reporter
• Language: Scala
• Homepage: https://www.codacy.com
• Size: 7.78 MB
• Stars: 135
• Watchers: 20
• Forks: 94
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• jimsghstars - codacy/codacy-coverage-reporter - Multi-language coverage reporter for Codacy (Scala)

README

        
# Codacy Coverage Reporter

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c56384a7b0044caea298480b9fde2522)](https://www.codacy.com/gh/codacy/codacy-coverage-reporter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-coverage-reporter&utm_campaign=Badge_Grade)

[![Build Status](https://circleci.com/gh/codacy/codacy-coverage-reporter.png?style=shield&circle-token=:circle-token)](https://circleci.com/gh/codacy/codacy-coverage-reporter)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.codacy/codacy-coverage-reporter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.codacy/codacy-coverage-reporter)

Multi-language coverage reporter for Codacy https://www.codacy.com

## Setup

Follow the instructions on how to [add coverage to your repository](https://docs.codacy.com/coverage-reporter/adding-coverage-to-your-repository/).

If necessary, see [alternative ways of running Codacy Coverage Reporter](https://docs.codacy.com/coverage-reporter/alternative-ways-of-running-coverage-reporter/) for other ways of running Codacy Coverage Reporter, such as by installing the binary manually or using a CircleCI Orb or the [Codacy Coverage Reporter GitHub Action](https://github.com/codacy/codacy-coverage-reporter-action).

For a complete list of commands and options, run the Codacy Coverage Reporter with the flag `--help`. For example:

```

$ bash <(curl -Ls https://coverage.codacy.com/get.sh) report --help

     ______          __

    / ____/___  ____/ /___ ________  __

   / /   / __ \/ __  / __ `/ ___/ / / /

  / /___/ /_/ / /_/ / /_/ / /__/ /_/ /

  \____/\____/\__,_/\__,_/\___/\__, /

                              /____/

  Codacy Coverage Reporter

 --> Using codacy reporter codacy-coverage-reporter-linux from cache

Command: report

Usage: codacy-coverage-reporter report 

  --project-token | -t  

  --api-token | -a  

  --organization-provider   (manual, gh, bb, ghe, bbe, gl, gle)

  --username | -u  

  --project-name | -p  

  --codacy-api-base-url  

  --commit-uuid  

  --http-timeout  

  --skip | -s  

  --sleep-time 

  --num-retries 

  --language | -l  

  --coverage-reports | -r  

  --partial  

  --prefix  

  --skip-ssl-verification [default: false] - Skip the SSL certificate verification when communicating with the Codacy API

  --force-coverage-parser  

        Available parsers are: opencover,clover,lcov,phpunit,jacoco,dotcover,cobertura,go

 --> Succeeded!

```

Codacy Coverage Reporter can be run with the `CODACY_REPORTER_OPTIONS` environment variable. This is useful for passing options to the reporter without having to modify the script.

```

CODACY_REPORTER_OPTIONS="--skip-ssl-verification true"

```

## What is Codacy?

[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.

### Among Codacy’s features:

- Identify new Static Analysis issues

- Commit and Pull Request Analysis with GitHub, GitLab, and Bitbucket

- Auto-comments on Commits and Pull Requests

- Integrations with Slack and Jira

- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories

Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.

Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.

### Free for Open Source

Codacy is free for Open Source projects.