Skip to content

Commit eec6070

Browse files
add docs for file coverage section
1 parent db8f020 commit eec6070

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed
494 KB
Loading

docs/organizations/reporting/organization-overview.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,19 +127,28 @@ For calculation details, see [how code coverage is calculated](../../faq/code-an
127127
### Coverage dashboard on Paid plans
128128

129129
![Image of the Coverage tab](./images/organization-overview-coverage.png)
130+
![Image of File Coverage section](./images/organization-overview-file-coverage.png)
130131

131-
The Coverage tab on paid plans uses two key metrics:
132-
133-
- **Covered lines**: Number of covered lines reported to Codacy.
134-
- **Coverable lines**: Number of lines that can be covered, based on coverage reports.
132+
The Coverage tab on paid plans is divided into two main sections:
133+
- **Line coverage** that uses three main metrics:
134+
- **Covered lines**: Number of covered lines reported to Codacy.
135+
- **Coverable lines**: Number of lines that can be covered, based on coverage reports.
136+
- **Coverage percentage**: The percentage of covered lines
137+
- **File coverage** that uses two main metrics:
138+
- **Files with coverage**: Number of files that have coverage
139+
- **Total files**: Total number of files
135140

136141
These metrics drive all dashboard components:
137142

138143
| Metric | Description |
139144
| ------ | ----------- |
140145
| **Coverage** | `coveredLines / coverableLines` <br/>Aggregation of all covered lines divided by all coverable lines across all repositories (or the current filter selection, see [filters](#overview-filters)). Includes only repositories reporting coverage. |
141146
| **Repositories reporting coverage** | Repositories with coverage data from the latest merged pull request. For example, if the latest merged pull request reported coverage metrics to Codacy, that repository is counted as reporting coverage. |
142-
| **Coverage trend** | Time-based trend for covered lines, uncovered lines, and organization coverage (or the current filter selection, see [filters](#overview-filters)). You can choose time ranges and granularities, and select a date to see which repositories changed the most during that period. |
147+
| **Coverage trend** | Time-based trend for covered lines, uncovered lines, and organization coverage (or the current filter selection, see [filters](#overview-filters)). You can choose time ranges and granularity, and select a date to see which repositories changed the most during that period. |
148+
| **File coverage** | `filesWithCoverage/ totalFiles` Aggregation of all the files that have coverage divided by all the files across all repositories (or the current filter selection, see [filters](#overview-filters)). Includes only languages that support coverage. |
149+
| **Files by coverage percentage** | Distribution chart grouping the files with coverage into coverage ranges: very low, low, medium, high, and very high. You can select one or more ranges to see the distribution of selected ranges for each language in the languages chart, each day in the trend chart, and the number of files within that range for each repository. |
150+
| **File coverage by language** | Language breakdown showing file coverage percentages and covered/total file counts per language.You can choose one or more languages to view coverage performance across your repositories for those selected languages. |
151+
| **File coverage trend** | Time-based trend for covered files, uncovered files, and overall file coverage percentage. You can choose time ranges and granularity, and select a date to see which repositories changed the most during that period. |
143152

144153
You can export data from each chart using the ellipsis icon in the top-right corner in JSON or CSV format.
145154

0 commit comments

Comments
 (0)