diff --git a/docs/organizations/codacy-usage.md b/docs/organizations/codacy-usage.md new file mode 100644 index 0000000000..bad8852b20 --- /dev/null +++ b/docs/organizations/codacy-usage.md @@ -0,0 +1,79 @@ +# Codacy usage + +The **Codacy usage** dashboard offers an overview of your organization's adoption of Codacy. You can filter the displayed list of repositories by their Git provider, as well as by their gate and coverage information within Codacy. Additionally, you can filter by selecting specific repositories or by using [the segments that you have set up](segments.md). + +![Codacy usage dashboard](images/codacy-usage-dashboard.png) + +!!! important + Repositories not in Codacy is only available to GitHub accounts. + +To view the **Codacy usage** dashboard: + +- Select an organization from the top navigation bar. +- On the organization overview page, click the Codacy usage tab. + +The Codacy usage dashboard includes the following sections to help you monitor Codacy adoption: + +- [Repositories](#repositories) +- [Repositories evolution](#repositories-evolution) +- [Merged pull requests](#merged-pull-requests) +- [Top repositories](#top-repositories) + +!!! tip + In each section, you can click on the ellipsis icon in the top right corner to export that section's data to CSV or JSON. + +## Repositories + +This chart displays the distribution of repositories in Codacy and repositories that aren't. The doughnut chart also details the breakdown of Codacy repositories based on their configuration: those without quality gates, without coverage, without either gates or coverage, and those with both gates and coverage. Users can interact with the doughnut chart or the numerical data to filter the results. Applying a filter will also affect the repositories displayed in the evolution chart and the results will appear in the "Top repositories" list. + +![Repositories distribution](images/repositories-distribution.png) + +## Repositories evolution + +This chart shows the trend of repositories in your organization over time, considering the filters applied. You can hover over the chart to see the number of repositories on a specific date. You can also click on the chart to filter results. + +![Repositories evolution](images/repositories-evolution.png) + +## Merged pull requests + +This chart tracks the total volume of pull requests merged across your Codacy-managed repositories. It serves as a high-level health check to ensure that your team's development velocity is aligned with your quality standards. + +### Understanding the categories + +- Passing Gates: These PRs met all your quality standards (e.g., coverage, complexity, security) before being merged. +- Failing Gates: PRs merged despite failing one or more quality checks. +- Without Gates: PRs merged into repositories where no quality gates are configured. +- Never Analyzed: PRs that reached a "Merged" status without Codacy completing an analysis. + +#### Why are some PRs "Never analyzed"? + +If you see high numbers here, it usually boils down to two scenarios: + +1. A developer merged the PR immediately after opening it, before the Codacy analysis could finish. Ensure your team adjusts their workflow to wait for the "Codacy/Analysis" check to turn green before merging. + +2. In self-service organizations, if a PR is authored by an email/user not yet added to your Codacy seat count, the analysis may be skipped. You should check your [seat management](../organizations/managing-people.md) to confirm that all active contributors are correctly mapped to a Codacy seat. + +#### Why are some PRs merged with "Failing gates"? + +Pull requests are merged with failing Quality Gates usually due to two reasons: + +1. Quality Gates are advisory, not blocking. [Protect your pull requests](../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests). + +2. Intentional exceptions or risk acceptance: + +- Developers/maintainers may override failing checks to address urgent fixes, unblock critical work, or accept a known risk temporarily. + +- Sometimes pull requests are small and diff coverage / coverage variation may fail. Make sure your team follows the practices that were agreed upon within the organization. + +Interacting with the chart allows you to filter the data, with the resulting repositories displayed in the "Top repositories" list. + +!!! note + Merged pull requests data is only from repositories that are in Codacy. + +![Merged pull requests](images/merged-pull-requests.png) + +## Top repositories + +The list shows a maximum of 10 repositories from your Git provider. You can use filters to display repositories that aren't yet in Codacy, or repositories that are already in Codacy. For repositories in Codacy, the list can also group them by specific metrics such as gates, coverage, and merged pull request information. + +![Top repositories](images/top-repositories.png) diff --git a/docs/organizations/images/codacy-usage-dashboard.png b/docs/organizations/images/codacy-usage-dashboard.png new file mode 100644 index 0000000000..bff4aaa6a3 Binary files /dev/null and b/docs/organizations/images/codacy-usage-dashboard.png differ diff --git a/docs/organizations/images/merged-pull-requests.png b/docs/organizations/images/merged-pull-requests.png new file mode 100644 index 0000000000..fcc70c0a79 Binary files /dev/null and b/docs/organizations/images/merged-pull-requests.png differ diff --git a/docs/organizations/images/repositories-distribution.png b/docs/organizations/images/repositories-distribution.png new file mode 100644 index 0000000000..10e25a2a06 Binary files /dev/null and b/docs/organizations/images/repositories-distribution.png differ diff --git a/docs/organizations/images/repositories-evolution.png b/docs/organizations/images/repositories-evolution.png new file mode 100644 index 0000000000..174e134208 Binary files /dev/null and b/docs/organizations/images/repositories-evolution.png differ diff --git a/docs/organizations/images/top-repositories.png b/docs/organizations/images/top-repositories.png new file mode 100644 index 0000000000..0a76b7f3f2 Binary files /dev/null and b/docs/organizations/images/top-repositories.png differ diff --git a/mkdocs.yml b/mkdocs.yml index f756b98b0f..2f75b977dc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -611,6 +611,7 @@ nav: - organizations/managing-repositories.md - organizations/segments.md - organizations/issues-metrics.md + - organizations/codacy-usage.md - organizations/ai-risk-hub.md - organizations/using-gate-policies.md - organizations/using-coding-standards.md