-
Notifications
You must be signed in to change notification settings - Fork 45
feat: new Coverage and overview metrics #2590
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
0f06b2c
8c137ed
3f1d93a
77cbf52
89cb2e9
733db4c
efd04e4
2eaac43
b69ded3
682086d
80d03fa
c68e045
6ad8833
0003e3d
076ed90
f1c9388
002e32a
8c6d571
e7a8727
8439800
6ce4f7d
5cbf748
881184f
d6056bd
296fa85
2fbfe72
9b25a38
f44c0d7
5a70702
de77f35
3733858
1e394cc
b7a00be
ec313a5
ecc5ab9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,149 @@ | ||
| --- | ||
| description: The Organization overview provides an overview of the repositories belonging to your Git provider organization. Here you can compare their statuses and check for items that require your attention. | ||
| description: The Organization overview summarizes repositories in your Git provider organization so you can compare status and quickly identify items that need attention. | ||
|
Check warning on line 2 in docs/organizations/reporting/organization-overview.md
|
||
| --- | ||
|
|
||
| # Organization overview | ||
|
|
||
| The **Organization overview** provides an overview of the repositories belonging to your Git provider organization that you [follow on Codacy](../managing-repositories.md). Here you can compare their statuses and check for items that require your attention. | ||
| Codacy provides high-level visibility into your organization's code quality, security posture, AI risk, usage, and configuration metrics. The **Organization overview** consolidates these signals in a single view. | ||
|
|
||
| To access your Organization overview, select an organization from the top navigation bar and select **Overview** on the left navigation sidebar. | ||
| The **Organization overview** summarizes repositories in your Git provider organization that you [follow on Codacy](../managing-repositories.md). Use it to compare repository status and identify areas that require action. | ||
|
|
||
| Use the drop-down list at the top of the page to filter the information displayed on all dashboard areas based on the repositories that you select. For example, you can use the filter to monitor the quality of the repositories maintained by specific teams or that include certain programming languages, or to ignore legacy repositories that are no longer maintained. The selected repositories are stored in your browser so that the same filter is applied between your visits to the Organization overview page. | ||
| To open the Organization overview, select an organization in the top navigation bar, then select **Overview** in the left sidebar. | ||
|
|
||
| On the Organization overview you have the following areas to help you monitor your repositories: | ||
|  | ||
|
|
||
| - [Overall quality chart](#overall-quality-chart) | ||
| - [Last updated repositories](#last-updated-repositories) | ||
| - [Issues metrics](issues-metrics.md) | ||
| The Organization overview includes the following tabs: | ||
|
|
||
| - [Overview](#overview) | ||
| - [Open issues](./issues-metrics.md) | ||
| - [Grade](#grade) | ||
| - [Complexity](#complexity) | ||
| - [Duplication](#duplication) | ||
| - [Coverage](#coverage) | ||
| - [Codacy usage](./codacy-usage.md) | ||
| - [AI Risk Hub](./ai-risk-hub.md) | ||
|
|
||
| On this page, you can also see the **Organization setup** area, which provides you with a checklist of items that you should complete to ensure that your organization is set up correctly and that you're getting the most out of Codacy. | ||
| <div id="overview-filters">Use the filters at the top of the page to scope all dashboard data by repositories or segments. For example, filter by repositories owned by specific teams, repositories using specific languages, or exclude legacy repositories that are no longer maintained. Filter selections are stored in your browser and persist across visits.</div> | ||
|
|
||
| The following sections provide a detailed description of the repository-related dashboard areas. | ||
| This page documents the Overview, Grade, Complexity, Duplication, and Coverage sections. | ||
|
|
||
| {% include-markdown "../../assets/includes/dashboard-api-report-note.md" %} | ||
|
|
||
| ## Overall quality chart | ||
| ## Overview | ||
|
|
||
| The **Overall quality** chart compares the repositories that you follow regarding [grade](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade), [issues](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues), [complex files](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity), [duplication](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication), and [code coverage](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage). Each tab displays the average value for the corresponding metric for the last updated repositories. | ||
| The Organization overview page includes the following areas to help you monitor repository health: | ||
|
|
||
| !!! important | ||
| - The overall quality chart calculates metrics and displays data only for the **repositories that you follow** on Codacy. This means that depending on their list of followed repositories, two users can see different results on this chart. | ||
| - [Code health and security](#code-health-and-security) | ||
| - [Last updated repositories](#last-updated-repositories) | ||
|
|
||
| This page also includes the **Organization setup** area, which provides a checklist of recommended actions to ensure your organization is configured correctly and fully using Codacy capabilities. | ||
|
|
||
| - The overall quality chart displays information for **at most the last 100 updated repositories**. | ||
| <div id="overall-quality-chart"></div> | ||
| ### Code health and security | ||
|
|
||
|  | ||
|  | ||
|
|
||
| - Hover the mouse pointer over the bars to see the metrics for the corresponding repositories. | ||
| - Click the bars to navigate directly to the corresponding repository. | ||
| The **Code health and security** area provides an organizational snapshot and highlights key hotspots. It shows open issues, new vs. fixed issues, prevented issues, and complexity, duplication, coverage, and security metrics. Select any metric to open detailed results. | ||
|
Check failure on line 46 in docs/organizations/reporting/organization-overview.md
|
||
|
|
||
| If you have over 8 repositories, the chart displays your repositories grouped by grade or percentage intervals. Click the bars to see and navigate directly to the corresponding repositories. | ||
| Some metrics depend on your billing plan and use plan-specific calculations. For details, see the following table: | ||
|
|
||
|  | ||
| | Metric | Availability | How it is calculated | | ||
|
Check failure on line 50 in docs/organizations/reporting/organization-overview.md
|
||
| | ------ | ------------ | -------------------- | | ||
| | Open issues, New and Fixed issues, and Prevented issues | Paid plans | [More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues) | | ||
| | Grade | Open source and trial plans | [More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade) | | ||
| | Complexity | All plans | [More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity) | | ||
| | Duplication | All plans | [More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication) | | ||
| | Coverage | All plans <a href="#coverage-note"><sup>1</sup></a> | [More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage) | | ||
| | Security | All plans | [More details](../managing-security-and-risk.md) | | ||
|
|
||
| !!! tip | ||
| If you don't have coverage set up for any of your repositories yet, the coverage tab provides you with instructions on [how to add coverage for your repositories](../../coverage-reporter/index.md). | ||
|
|
||
| !!! important | ||
| - The **Code health and security** area calculates and displays metrics only for **repositories you follow** on Codacy. As a result, users with different followed repositories can see different values. | ||
|
|
||
| - Some organization-level metrics are limited to the 100 most recently updated repositories, depending on the metric and plan. | ||
|
|
||
| <sup><span id="coverage-note">1</span></sup>: Coverage metrics are calculated differently for paid plans versus open source and trial plans. [Learn more](#coverage). | ||
|
|
||
| ## Last updated repositories | ||
| ### Last updated repositories | ||
|
|
||
| The **Last updated repositories** list displays the last updated repositories, sorted by reverse date of the last update. | ||
| The **Last updated repositories** list shows repositories sorted by most recent update first. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| !!! note | ||
| The exact value of the last updated date of the repositories depends on your Git provider: | ||
| The source of the "last updated" value depends on your Git provider: | ||
|
|
||
| - **GitHub:** date of the last commit to any branch of the repository (value of `pushed_at` from the [GitHub Repositories API](https://docs.github.com/en/rest/repos/repos#list-organization-repositories){: target=_"blank"}). | ||
| - **GitLab:** date when the project was last updated (value of `last_activity_at` from the [GitLab Groups API](https://docs.gitlab.com/ee/api/groups.html)). Note that this value is only updated [at most once per hour](https://gitlab.com/gitlab-org/gitlab/-/issues/20952)). | ||
| - **Bitbucket:** date when the repository was last updated (value of `updated_on` from the [Bitbucket Repositories API](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-group-repositories)). **On Bitbucket Server** Codacy can't obtain this information and the list displays the repositories in alphabetical order. | ||
| - **GitHub:** Date of the most recent commit to any branch (`pushed_at` in the [GitHub Repositories API](https://docs.github.com/en/rest/repos/repos#list-organization-repositories)). | ||
| - **GitLab:** Date when the project was last updated (`last_activity_at` in the [GitLab Groups API](https://docs.gitlab.com/ee/api/groups.html)). This value updates [at most once per hour](https://gitlab.com/gitlab-org/gitlab/-/issues/20952). | ||
| - **Bitbucket:** Date when the repository was last updated (`updated_on` in the [Bitbucket Repositories API](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-group-repositories)). On **Bitbucket Server**, Codacy cannot retrieve this value, so repositories are listed alphabetically. | ||
|
|
||
| ## See also | ||
| ## Grade | ||
|
|
||
|  | ||
|
|
||
| The **Grade** tab shows grade distribution across repositories. Use this view to identify higher-risk repositories by selecting a grade in the distribution chart. | ||
|
|
||
| At organization level, **Grade** is the average grade across the 100 most recently updated repositories. | ||
|
|
||
| For calculation details, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade). | ||
|
|
||
| ## Complexity | ||
|
|
||
|  | ||
|
|
||
| The **Complexity** tab helps identify repositories where code may be harder to test and more defect-prone. | ||
|
|
||
| At organization level, **Complexity** is the percentage of complex files across the 100 most recently updated repositories. | ||
|
|
||
| This tab shows your organization's complexity status (based on complex file counts) and how repositories compare against configured [goals](../../repositories-configure/adjusting-quality-goals.md). A file is considered complex when its cyclomatic complexity exceeds the repository-level goal. For details, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity). | ||
|
|
||
| The panel classifies the top 100 most recently updated repositories as above goal, below goal, or without a goal. Because lower complexity is better, repositories above goal are highlighted for review. | ||
|
|
||
| At the bottom of the tab, complex-file distribution shows whether files above goal, below goal, or without goals are driving complexity. Repository goal distributions are filterable; file-level data is not. | ||
|
Check failure on line 102 in docs/organizations/reporting/organization-overview.md
|
||
|
|
||
| ## Duplication | ||
|  | ||
|
|
||
| The **Duplication** tab identifies repeated code sequences that appear in at least two locations in a repository. | ||
|
|
||
| At organization level, **Duplication** is the average duplication across the 100 most recently updated repositories. | ||
|
|
||
| This tab shows average duplication and indicates which repositories are above goal, below goal, or without configured [goals](../../repositories-configure/adjusting-quality-goals.md). | ||
|
|
||
| For metric details, see [how duplication is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication). | ||
|
|
||
|
|
||
| ## Coverage | ||
|
|
||
| The **Coverage** tab provides organization-level visibility into coverage status. Higher coverage helps reduce regression risk when code changes. | ||
|
|
||
| At organization level, **Coverage** depends on your plan: | ||
|
|
||
| - On trial and open source plans, it is the average coverage across the 100 most recently updated repositories. | ||
|
Check failure on line 122 in docs/organizations/reporting/organization-overview.md
|
||
| - On paid plans, it is a line-based percentage calculated as `coveredLines / coverableLines` across repositories that report coverage. | ||
|
Check failure on line 123 in docs/organizations/reporting/organization-overview.md
|
||
|
|
||
| For calculation details, see [how code coverage is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage). | ||
|
|
||
| ### Coverage dashboard on Paid plans | ||
|
|
||
|  | ||
|
|
||
| The Coverage tab on paid plans uses two key metrics: | ||
|
|
||
| - **Covered lines**: Number of covered lines reported to Codacy. | ||
| - **Coverable lines**: Number of lines that can be covered, based on coverage reports. | ||
|
|
||
| These metrics drive all dashboard components: | ||
|
|
||
| | Metric | Description | | ||
| | ------ | ----------- | | ||
| | **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. | | ||
| | **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. | | ||
| | **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. | | ||
|
Check failure on line 142 in docs/organizations/reporting/organization-overview.md
|
||
|
|
||
| You can export data from each chart using the ellipsis icon in the top-right corner in JSON or CSV format. | ||
|
|
||
| ## See also | ||
| - [Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate.md) | ||
| - [Using the Codacy API to obtain current issues in repositories](../../codacy-api/examples/obtaining-current-issues-in-repositories.md) | ||
| - [Using the Codacy API to obtain code quality metrics for files](../../codacy-api/examples/obtaining-code-quality-metrics-for-files.md) | ||
Uh oh!
There was an error while loading. Please reload this page.