-
Notifications
You must be signed in to change notification settings - Fork 44
feat: add codacy usage docs [LK-1802] #2535
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
Open
joanasteodoro
wants to merge
2
commits into
master
Choose a base branch
from
add-codacy-usage-docs-lk-1802
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Codacy usage | ||
|
|
||
| The **Codacy usage** dashboard provides an overview of how your organization is adopting Codacy. You can view and filter the list of repositories from your Git provider. You can also filter repositories in Codacy by gate and coverage information. You can also filter by selecting specific repositories or using [the segments that you have set up](segments.md). | ||
|
|
||
|  | ||
|
|
||
| !!! important | ||
| Repositories not in Codacy is only available to GitHub accounts. | ||
|
|
||
| To access the Codacy usage dashboard, select an organization from the top navigation bar and click on the **Codacy usage** tab at the top of the page. | ||
|
|
||
| On the tab, if your Git provider is GitHub, you can view the percentage of repositories added to Codacy. Otherwise, you'll see the total number of repositories in Codacy. | ||
|
|
||
| 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 not in Codacy. On the pie chart, around the number of repositories in Codacy, you can also see the distribution of repositories without gates, without coverage, without gates nor coverage, and with gates and coverage. You can click both on the pie chart and numbers to filter the results in the rest of the dashboard. | ||
|
|
||
|  | ||
|
|
||
| ## 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 in the dashboard. | ||
|
|
||
| !!! important | ||
| Data for each period represents an average of the values during that period. | ||
|
|
||
|  | ||
|
|
||
| ## Merged pull requests | ||
|
|
||
| This chart displays the number of pull requests merged in your repositories. Merged pull requests are distributed in two main categories - analyzed and not analyzed. Analyzed merged pull requests are shown in three different categories - passing gates, failing gates, and without gates. You can click on the chart to filter results in the dashboard. | ||
|
|
||
| !!! note | ||
| Merged pull requests data is only from repositories that are in Codacy. | ||
|
|
||
|  | ||
|
|
||
| ## Top repositories | ||
|
|
||
| This list displays a maximum of 10 repositories in your Git provider. Depending on the filters applied, the list will show repositories not in Codacy, repositories in Codacy, or repositories in Codacy grouped by a specific dimension, such as gates information and/or coverage information. | ||
|
|
||
|  | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.