You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/organizations/reporting/organization-overview.md
+39-39Lines changed: 39 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
---
2
-
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.
2
+
description: The Organization overview summarizes repositories in your Git provider organization so you can compare status and quickly identify items that need attention.
3
3
---
4
4
5
5
# Organization overview
6
6
7
-
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.
7
+
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.
8
8
9
-
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.
9
+
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.
10
10
11
-
To access your Organization overview, select an organization from the top navigation bar and select **Overview**on the left navigation sidebar.
11
+
To open the Organization overview, select an organization in the top navigation bar, then select **Overview**in the left sidebar.
12
12
13
13
14
14
15
-
The Organization overview contains the following tabs:
15
+
The Organization overview includes the following tabs:
16
16
17
17
-[Overview](#overview)
18
18
-[Open issues](./issues-metrics.md)
@@ -23,29 +23,29 @@ The Organization overview contains the following tabs:
23
23
-[Codacy usage](./codacy-usage.md)
24
24
-[AI Risk Hub](./ai-risk-hub.md)
25
25
26
-
<divid="overview-filters">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.</div>
26
+
<divid="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>
27
27
28
-
This page covers the Overview, Grade, Complexity, Duplication, and Coverage sections.
28
+
This page documents the Overview, Grade, Complexity, Duplication, and Coverage sections.
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.
39
+
This pagealso includes the **Organization setup** area, which provides a checklist of recommended actions to ensure your organization is configured correctly and fully using Codacy capabilities.
40
40
41
41
<divid="overall-quality-chart"></div>
42
42
### Code health and security
43
43
44
44
45
45
46
-
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.
46
+
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.
47
47
48
-
Some of these metrics depend on your billing plan and are calculated differently. For details, see the following table:
48
+
Some metrics depend on your billing plan and use plan-specific calculations. For details, see the following table:
49
49
50
50
| Metric | Availability | How it is calculated |
51
51
| ------ | ------------ | -------------------- |
@@ -58,90 +58,90 @@ Some of these metrics depend on your billing plan and are calculated differently
58
58
59
59
60
60
!!! important
61
-
- The **Code health and security** area 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.
61
+
- The **Code health and security** area calculates and displays metrics only for **repositories you follow** on Codacy. As a result, users with different followed repositoriescan see different values.
62
62
63
-
- Some organization-level metrics are limited to the 100 most recently updated repositories, depending on the metric and your plan.
63
+
- Some organization-level metrics are limited to the 100 most recently updated repositories, depending on the metric and plan.
64
64
65
-
<sup><spanid="coverage-note">1</span></sup>: Coverage metrics are calculated differently for paid plans and for open source and trial plans. [Learn more](#coverage).
65
+
<sup><spanid="coverage-note">1</span></sup>: Coverage metrics are calculated differently for paid plans versus open source and trial plans. [Learn more](#coverage).
66
66
67
67
### Last updated repositories
68
68
69
-
The **Last updated repositories** list displays the last updated repositories, sorted by reverse date of the last update.
69
+
The **Last updated repositories** list shows repositories sorted by most recent update first.
The exact value of the last updated date of the repositories depends on your Git provider:
74
+
The source of the "last updated" value depends on your Git provider:
75
75
76
-
- **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"}).
77
-
- **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)).
78
-
- **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.
76
+
- **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){: target=_"blank"}).
77
+
- **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).
78
+
- **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.
79
79
80
80
## Grade
81
81
82
82
83
83
84
-
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.
84
+
The **Grade** tab shows grade distribution across repositories. Use this view to identify higher-risk repositories by selecting a grade in the distribution chart.
85
85
86
86
At organization level, **Grade** is the average grade across the 100 most recently updated repositories.
87
87
88
-
To learn more about how grades are calculated [see how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade).
88
+
For calculation details, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade).
89
89
90
90
## Complexity
91
91
92
92
93
93
94
-
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.
94
+
The **Complexity** tab helps identify repositories where code may be harder to test and more defect-prone.
95
95
96
96
At organization level, **Complexity** is the percentage of complex files across the 100 most recently updated repositories.
97
97
98
-
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 repositorylevel. To learn more, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity).
98
+
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).
99
99
100
-
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.
100
+
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.
101
101
102
-
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.
102
+
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.
103
103
104
104
## Duplication
105
105
106
106
107
-
Duplication allows you to check if sequences of duplicate code exist in at least two different places of the source code of your repository.
107
+
The **Duplication** tab identifies repeated code sequences that appear in at least two locations in a repository.
108
108
109
109
At organization level, **Duplication** is the average duplication across the 100 most recently updated repositories.
110
110
111
-
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).
111
+
This tab shows average duplication and indicates which repositories are above goal, below goal, or without configured [goals](../../repositories-configure/adjusting-quality-goals.md).
112
112
113
-
To learn more about duplication metrics, see [how duplication is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication).
113
+
For metric details, see [how duplication is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication).
114
114
115
115
116
116
## Coverage
117
117
118
-
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.
118
+
The **Coverage** tab provides organization-level visibility into coverage status. Higher coverage helps reduce regression risk when code changes.
119
119
120
120
At organization level, **Coverage** depends on your plan:
121
121
122
122
- On trial and open source plans, it is the average coverage across the 100 most recently updated repositories.
123
-
- On paid plans, it is a line-based percentage calculated as `coveredLines / coverableLines` across repositories reporting coverage.
123
+
- On paid plans, it is a line-based percentage calculated as `coveredLines / coverableLines` across repositories that report coverage.
124
124
125
-
To understand better how coverage is calculated, [learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage).
125
+
For calculation details, see [how code coverage is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage).
126
126
127
127
### Coverage dashboard on Paid plans
128
128
129
129
130
130
131
-
The Coverage tab is based on two key metrics:
131
+
The Coverage tab on paid plans uses two key metrics:
132
132
133
-
-**Covered lines**: number of covered lines reported into Codacy;
134
-
-**Coverable lines**: number of lines that can be covered based on your coverage reports.
133
+
-**Covered lines**: Number of covered lines reported to Codacy.
134
+
-**Coverable lines**: Number of lines that can be covered, based on coverage reports.
135
135
136
-
These metrics are the basis of all components in this dashboard:
136
+
These metrics drive all dashboard components:
137
137
138
138
| Metric | Description |
139
139
| ------ | ----------- |
140
-
|**Coverage**|`coveredLines / coverableLines` <br/>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. |
141
-
|**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. |
142
-
|**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. |
140
+
|**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. |
141
+
|**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. |
143
143
144
-
You can download data from each chart using the ellipsis icon in the top-right corner and export values in JSON or CSV format.
144
+
You can export data from each chart using the ellipsis icon in the top-right corner in JSON or CSV format.
145
145
146
146
## See also
147
147
-[Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate.md)
0 commit comments