GitHub Integration

After adding a project, you may want to enable GitHub integration to be able to comment on commits, create issues and more.

To do so, simply navigate to your Project Settings, and select the Integrations tab. It gets installed in just one click but you may need to move back and forth between Codacy and GitHub if additional permissions are required.

After installing it for a project, it needs to be enabled by a user that has project access on GitHub. For private projects, this user will by default become the GitHub user that Codacy will use to comment and create issues on GitHub. For public projects, comments made by Codacy will appear as coming from codacy-bot.


Enabling GitHub integration



Once the integration is enabled, you will see additional options when browsing the existing issues on the project:


GitHub integration


If you enable Pull Request Status, Pull Request Comment or Pull Request Summary Codacy will be able to automatically update pull requests on GitHub with additional information when accepting pull requests.


Additional options


Pull Request Status shows whether your PR and coverage are up to standards or not as per the Pull Request Quality Settings set up for your project. To see the coverage status, please make sure that the Coverage option is enabled in the PR Quality settings.

image.pngPull request status

Pull Request Comment makes a comment on the Pull Request line when a new issue is found and shows the pattern that raised the issue. When you click on the Issue link you will be redirected to Codacy where you can see more details about the issue and how to fix it. 

Pull request comment
Pull Request Summary shows an overall view of the changes that occurred in the PR. This includes new issues that are found and other metrics such as complexity and duplication. 
Pull request summary
Have more questions? Submit a request


Article is closed for comments.