Skip to content
This documentation applies to Codacy Self-hosted

For the latest updates and improvements, see the latest Cloud documentation instead.

GitHub Integration

After adding a repository, navigate to your repository's Settings -> Integrations tab to enable GitHub integration for comments on pull requests, issue creation, and more.

It installs in just one click but you may need to move back and forth between Codacy and GitHub if it requires additional permissions.

After installing it for a repository, it has to be enabled by a user with repository access on GitHub. For private repositories, this user will by default become the GitHub user that Codacy will use to comment and create issues on GitHub. For public repositories, 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 repository:

GitHub integration

Enabling Pull Request StatusPull Request Comment or Pull Request Summary Codacy will automatically update pull requests on GitHub with additional information when accepting pull requests.

Additional options

Pull Request Comment makes a comment on the Pull Request line when a new issue is found and shows the pattern raising the issue. Click on the Issue link to go to Codacy to see more details about the issue and how to fix it.

Screen_Shot_2017-11-15_at_18.23.26.png Pull request comment

Pull Request Summary shows an overall view of the changes in the PR. Including newly found issues and other metrics such as complexity and duplication. 

Screen_Shot_2017-11-15_at_18.12.58.png Pull request summary

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?

We're sorry to hear that. Please let us know what we can improve:

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.

Last modified January 14, 2022