For the latest updates and improvements, see the latest Cloud documentation instead.
Issues page#
The Issues page lists all the issues that Codacy detected in your repository, including the severity level and category of each issue.
By default, the page lists the issues on the main branch of your repository but if you have more than one branch enabled you can use the drop-down list at the top of the page to display issues on other branches.
Note
You can use the Codacy API to generate reports or obtain information about the current issues in your repositories in a more flexible way.
Click the title of an issue to see the following information:
- The contributor and date of the commit that introduced the issue
- The tool that reported the issue and the estimated time to fix it
- What's the issue and how to solve it
- The programming language and category of the issue
Filtering issues#
Filter the list of issues to find specific issues, such as the issues with the highest severity or security issues:
You can define one or more of the following filters:
-
Language: Programming language of the file where the issues were detected
-
Issue category: One of the following types of issue:
- Code Style: Code formatting and syntax problems, such as variable names style and enforcing the use of brackets and quotation marks
- Error Prone: Code that may hide bugs and language keywords that should be used with caution, such as the operator
==in JavaScript orOption.getin Scala - Code Complexity: High complexity methods and classes that should be refactored
- Performance: Code that can have performance problems
- Compatibility: Mainly for frontend code, compatibility problems across different browser versions
- Unused Code: Unused variables and methods, code that can't be reached
- Security: All security problems
- Documentation: Methods and classes that don't have the correct comment annotations
-
Severity level: Potential impact of the issues:
- Critical (red): The most dangerous issues that you should prioritize fixing since they identify code that's susceptible to serious problems regarding security and compatibility
- Medium (yellow): You should check out these issues, as they're based on coding standards and conventions
- Minor (blue): The least critical issues, such as most code style issues
-
Pattern: Code pattern that detected the issue
-
Author: Commit author that introduced the issue on the code
Note
Each code pattern has a pre-defined severity level and at the moment Codacy doesn't support customizing that information.
Ignoring and managing issues#
Use the options in the cogwheel menu of each issue to:
-
Ignore the issue and hide it from the list.
Codacy will no longer report the issue after the next analysis of your repository. For example, you can ignore issues that you disagree with because:
- Your team won't tackle the issues in the immediate future
- The issue isn't relevant in the specific context of your code
- The issue is a false positive
See how to restore ignored issues.
Tip
Organization owners can configure who is allowed to ignore issues.
-
Disable the code pattern that detected the issue.
Codacy will stop using that pattern after the next analysis of your repository, so be sure that you're no longer interested in identifying similar issues. To re-enable patterns use the Code patterns page.
Note
- If you're using a custom configuration file, you must manage patterns manually on your configuration file.
- If your repository is following an organization coding standard, disabling the code pattern causes the repository to stop following the coding standard. In this case Codacy asks for your confirmation before accepting the changes, and then copies the coding standard configurations to your repository so you can customize them.
-
Ignore the file where the issue was detected.
Codacy will no longer analyze that file on your repository, so be sure that you're no longer interested in identifying any type of issues on that file. To remove an ignored file use the Ignored Files tab in your repository settings.
The menu can include more options depending on the features that you enable on your GitHub or Bitbucket integration:
Restoring ignored issues#
To see the list of ignored issues, click Current Issues and select Ignored Issues.
To restore an ignored issue, click the button Unignore next to the issue title:
See also#
Share your feedback 📢
Did this page help you?
Thanks for the feedback! Is there anything else you'd like to tell us about this page?
255 characters left
We're sorry to hear that. Please let us know what we can improve:
255 characters left
Alternatively, you can create a more detailed issue on our GitHub repository.
Thanks for helping improve the Codacy documentation.
If you have a question or need help please contact support@codacy.com.