Skip to content

GitHub integration#

The GitHub integration incorporates Codacy on your existing Git provider workflows by reporting issues and the analysis status directly on your pull requests.

When the integration is enabled, you can also create pull request comments and GitHub issues directly from Codacy when browsing the existing issues on the repository:

GitHub integration for issues

Enabling the GitHub integration#

To enable the GitHub integration, open your repository Settings, tab Integrations. When you add a new repository, Codacy enables the integration using the default settings for your organization.

GitHub integration

If you remove the integration, you can enable it again as follows:

  1. Click the button Add integration and select GitHub on the list.
  2. Click the button Enable and follow the instructions.

    Important

    The user that enables the integration must have administrator access to the repository.

Configuring the GitHub integration#

To configure the GitHub integration, open your repository Settings, tab Integrations.

Depending on the options that you enable, Codacy will automatically update pull requests on GitHub with extra information when accepting pull requests.

Tip

You can apply the default Git provider integration settings to all repositories to ensure that your repositories all share the same settings.

Status checks#

Adds a report to your pull requests showing whether your pull requests and coverage are up to standards or not as configured on the quality gate rules for your repository. You can then optionally block merging pull requests that aren't up to standards.

Important

To get a status for coverage you must also:

Pull request status check on GitHub

Issue annotations#

Adds annotations on the lines of the pull request where Codacy finds new issues. Codacy maps the severity of the issues reported by the tools to the severity levels of the annotations. To enable this option, you must enable Status checks first.

Issue annotation on GitHub

Issue summaries#

Shows an overall view of the changes in the pull request, including new issues and metrics such as complexity and duplication. To enable this option, you must enable Status checks first.

Issue summary on GitHub

Coverage summaries#

Adds a pull request comment showing an overall view of the coverage metrics for the pull request, including details about the data that Codacy used to calculate the coverage variation and diff coverage metrics.

When there are new coverage results, Codacy updates the last coverage summary comment if it's included in the last 5 comments of the pull request. Otherwise, Codacy creates a new comment.

Important

To get coverage summaries you must also add coverage to your repository.

Coverage summary on GitHub

Note

This feature is only supported on GitHub Cloud.

Suggested fixes#

Adds comments on the lines of the pull request where Codacy finds new issues with suggestions on how to fix the issues. Codacy doesn't apply any changes automatically. To apply the changes, manually review and accept the suggestions.

Comment suggesting a fix on GitHub

Note

This feature is in early access and has the following limitations for now:

  • The only supported Git providers are GitHub Cloud and GitHub Enterprise.
  • The only two tools that suggest fixes are ESLint and markdownlint. However, we're planning to support suggestions from more tools.

📢 Activate suggested fixes now and let us know what you think!

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?

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.

Edit this page on GitHub if you notice something wrong or missing.

If you have a question or need help please contact support@codacy.com.

Last modified May 15, 2023