diff --git a/docs/organizations/reporting/images/organization-overview-code-health-security.png b/docs/organizations/reporting/images/organization-overview-code-health-security.png new file mode 100644 index 0000000000..40b50329e6 Binary files /dev/null and b/docs/organizations/reporting/images/organization-overview-code-health-security.png differ diff --git a/docs/organizations/reporting/images/organization-overview-complexity.png b/docs/organizations/reporting/images/organization-overview-complexity.png new file mode 100644 index 0000000000..ea97951105 Binary files /dev/null and b/docs/organizations/reporting/images/organization-overview-complexity.png differ diff --git a/docs/organizations/reporting/images/organization-overview-coverage.png b/docs/organizations/reporting/images/organization-overview-coverage.png new file mode 100644 index 0000000000..48202e7185 Binary files /dev/null and b/docs/organizations/reporting/images/organization-overview-coverage.png differ diff --git a/docs/organizations/reporting/images/organization-overview-duplication.png b/docs/organizations/reporting/images/organization-overview-duplication.png new file mode 100644 index 0000000000..064da86469 Binary files /dev/null and b/docs/organizations/reporting/images/organization-overview-duplication.png differ diff --git a/docs/organizations/reporting/images/organization-overview-grade.png b/docs/organizations/reporting/images/organization-overview-grade.png new file mode 100644 index 0000000000..1878f976c2 Binary files /dev/null and b/docs/organizations/reporting/images/organization-overview-grade.png differ diff --git a/docs/organizations/reporting/images/organization-overview.png b/docs/organizations/reporting/images/organization-overview.png new file mode 100644 index 0000000000..3ec2aecc0e Binary files /dev/null and b/docs/organizations/reporting/images/organization-overview.png differ diff --git a/docs/organizations/reporting/organization-overview.md b/docs/organizations/reporting/organization-overview.md index 4410a8ea32..f6d9c9a218 100644 --- a/docs/organizations/reporting/organization-overview.md +++ b/docs/organizations/reporting/organization-overview.md @@ -4,49 +4,69 @@ description: The Organization overview provides an overview of the repositories # 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 gives you high-level visibility into your organization's code quality, security posture, AI risks, and usage and configuration metrics. In the **Organization overview**, you can see these metrics at a glance. + +The **Organization overview** summarizes 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. To access your Organization overview, select an organization from the top navigation bar and select **Overview** on the left navigation sidebar. -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. +![Image of the Organization Overview on the Overview tab](./images/organization-overview.png) -On the Organization overview you have the following areas to help you monitor your repositories: +The Organization overview contains the following tabs: -- [Overall quality chart](#overall-quality-chart) -- [Last updated repositories](#last-updated-repositories) -- [Issues metrics](issues-metrics.md) +- [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. +
Use the filters at the top of the page to filter all dashboard information by repositories or segments. For example, use filters to monitor repositories maintained by specific teams or repositories using specific programming languages, or to ignore legacy repositories that are no longer maintained. Your filter selection is stored in your browser, so your view is preserved between visits.
-The following sections provide a detailed description of the repository-related dashboard areas. +This page covers 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. +On the Organization overview page, you have the following areas to help you monitor your repositories: -!!! 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) - - The overall quality chart displays information for **at most the last 100 updated repositories**. +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. + +
+### Code health and security + +![Image of Code health and security section](./images/organization-overview-code-health-security.png) -![Overall quality chart](images/organization-overview-overall-quality.png) +The **Code health and security** area provides a snapshot of your organization and key hotspots. Here, you can see at a glance open issues, new vs. fixed issues, prevented issues, and complexity, duplication, coverage, and security metrics. You can click any metric to see more details. -- 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. +Some of these metrics depend on your billing plan and are calculated differently. For details, see the following table: -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. +| Metric | Availability | How it is calculated | +| ------ | ------------ | -------------------- | +| 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 1 | [More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage) | +| Security | All plans | [More details](../managing-security-and-risk.md) | -![Overall quality chart with grouped repositories](images/organization-overview-overall-quality-grouped.png) -!!! 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 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. + + - Metrics like grade, complexity, duplication, and coverage (on free plans) represent **at most the last 100 updated repositories**. +1: Coverage metrics are calculated differently for paid plans and for open source and trial plans. [Learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-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 displays the last updated repositories, sorted by reverse date of the last update. ![Last updated repositories](images/organization-overview-repositories-last-updated.png) @@ -57,8 +77,74 @@ The **Last updated repositories** list displays the last updated repositories, s - **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. -## See also +## Grade + +![Image of the Grade tab](./images/organization-overview-grade.png) + +The **Grade** tab gives you visibility into grade distribution across your repositories. From this tab, you can identify the repositories with the highest risk by selecting a grade in the distribution chart. + +To learn more about how grades are calculated [see how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade). + +!!! important + Grade metrics are based **at most on the last 100 updated repositories**. + +## Complexity + +![Image of the Complexity tab](./images/organization-overview-complexity.png) + +Complexity allows you to understand which repositories are at risk of having code that is more difficult to test and more likely to have defects. + +In this tab, you can understand your organization's complexity status (based on the number of complex files) and how repositories compare against their [goals](../../repositories-configure/adjusting-quality-goals.md). A file is considered complex if its cyclomatic complexity value is higher than the goal defined at repository level. To learn more, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity). + +This panel shows, from the top 100 most recently updated repositories, which repositories are above goal, below goal, or have no goal. Because complexity is better when lower, repositories above goal are highlighted so you can review and act on them. +At the bottom of the tab, the complex files distribution helps you understand which files are complex because they are above goal, below goal, or in repositories without a goal. Files are not filterable, while repository goal distributions are. + +!!! important + Complexity metrics are based **at most on the last 100 updated repositories**. + +## Duplication +![Image of the Duplication tab](./images/organization-overview-duplication.png) + +Duplication allows you to check if sequences of duplicate code exist in at least two different places of the source code of your repository. + +In this tab, you can see your average duplication and check which repositories are above goal, below goal, or without configured [goals](../../repositories-configure/adjusting-quality-goals.md). + +To learn more about duplication metrics, see [how duplication is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication). + +!!! important + Duplication metrics are based **at most on the last 100 updated repositories**. + + +## Coverage + +![Image of the Coverage tab](./images/organization-overview-coverage.png) + +The **Coverage** tab provides organization-level visibility into your coverage status. Strong coverage helps protect your code and reduce the risk of regressions when code changes. + +!!! important + The Coverage tab has two modes: + - On trial and open source plans, you can see the average repository coverage across the 100 most recently updated repositories. This includes visibility into which repositories are above goal, below goal, or without a goal, similar to the Duplication and Complexity tabs. + - On paid plans, the dashboard removes the 100-repository limitation and provides additional metrics to help you prioritize improvements. This is the mode covered in this page. + + To understand better how these metrics are calculated, [learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage). + +The Coverage tab is based on two key metrics: + +- **Covered lines**: number of covered lines reported into Codacy; +- **Coverable lines**: number of lines that can be covered based on your coverage reports. + +These metrics are the basis of all components in this dashboard: + +| Metric | Description | +| ------ | ----------- | +| **Coverage** | _coveredLines / coverableLines_
Aggregation of all covered lines divided by all coverable lines across all repositories (or your filter selection, see [filters](#overview-filters)). This metric only includes repositories reporting coverage. | +| **Repositories reporting coverage** | Repositories that have coverage based on 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** | Trend over time for covered lines, uncovered lines, and organization coverage (or your filter selection, see [filters](#overview-filters)). You can select different time ranges and granularities, and select a date to see which repositories changed most in that period. | + +You can download data from each chart using the ellipsis icon in the top-right corner and export values 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)