Skip to content

Commit

Permalink
Merge pull request #357 from codacy/doc/code-coverage-not-test-coverage
Browse files Browse the repository at this point in the history
clean: Replace "test coverage" with "code coverage"
  • Loading branch information
Paulo Ribeiro authored Jan 19, 2022
2 parents a0537d9 + 7621e34 commit 30514f5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
description: Generate coverage reports in a supported format and upload them to Codacy to monitor the test coverage of your repositories on Codacy.
description: Generate coverage reports in a supported format and upload them to Codacy to monitor the code coverage of your repositories on Codacy.
---

# Adding coverage to your repository

Code coverage is a metric used to describe the degree to which the source code of a program is tested. A program with high code coverage has been more thoroughly tested and has a lower chance of containing software bugs than a program with low code coverage. You can read more about the [basics of code coverage](https://blog.codacy.com/a-guide-to-code-coverage-part-1-code-coverage-explained/) on Codacy's blog.

Complete these main steps to start monitoring the test coverage of your repositories on Codacy:
Complete these main steps to start monitoring the code coverage of your repositories on Codacy:

1. **Generating coverage reports**

Ensure that you're generating one of the test coverage report formats supported by Codacy on each push to your repository.
Ensure that you're generating one of the code coverage report formats supported by Codacy on each push to your repository.

1. **Uploading coverage data to Codacy**

Expand Down Expand Up @@ -111,7 +111,7 @@ If you're generating a report format that Codacy doesn't support yet, [contribut
This will generate a file `cobertura.xml` inside the folder `<report-output-dir>`.

- [dariodf/lcov_ex](https://github.com/dariodf/lcov_ex): generate LCOV reports for Elixir projects
- [chrisgit/sfdx-plugins_apex_coverage_report](https://github.com/chrisgit/sfdx-plugins_apex_coverage_report): generate LCOV or Cobertura reports from [Apex](https://help.salesforce.com/articleView?id=sf.code_apex_dev_guide_tools.htm&type=5) test coverage data
- [chrisgit/sfdx-plugins_apex_coverage_report](https://github.com/chrisgit/sfdx-plugins_apex_coverage_report): generate LCOV or Cobertura reports from [Apex](https://help.salesforce.com/articleView?id=sf.code_apex_dev_guide_tools.htm&type=5) code coverage data
- [danielpalme/ReportGenerator](https://github.com/danielpalme/ReportGenerator): convert between different report formats

As a last resort, you can also send the coverage data directly by calling one of the following Codacy API endpoints:
Expand Down

0 comments on commit 30514f5

Please sign in to comment.