Skip to content
This documentation applies to Codacy Self-hosted v8.0.0

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

GitLab integration#

The GitLab integration incorporates Codacy on your existing Git provider workflows.

Depending on the configuration of the GitLab integration, Codacy can report and notify you about issues directly on your merge requests.

Enabling the GitLab integration#

To enable the GitLab integration, open your repository Settings, tab Integrations. When you add a new repository, the integration is already enabled by default.

GitLab integration

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

  1. Click the button Add integration and select GitLab 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. Codacy uses this GitLab user to create comments on merge requests.

    Tip

    We recommend that you use a dedicated service account for integrating Codacy with your repositories. This will avoid disruption of service if the user who originally enabled the integration stops having access to the repository, such as when the user leaves the team or the organization.

    For more information and instructions on how to set up a dedicated service account see Why did Codacy stop commenting on pull requests?

Configuring the GitLab integration#

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

Depending on the options that you enable, Codacy will automatically update merge requests on GitLab with extra information when accepting merge requests:

Pull Request Status#

Adds a report to your merge requests showing whether your merge requests and coverage are up to standards or not as configured on the quality settings of your project.

Important

To get a status for coverage you must also:

To block merging merge requests that aren't up to standards see How do I block merging pull requests using Codacy as a quality gate?

Merge request status on GitLab

Pull Request Comment#

Adds comments on the lines of the merge request where Codacy finds new issues. Click on the links to open Codacy and see more details about the issues and how to fix them.

Merge request comment on GitLab

Pull Request Summary#

Shows an overall view of the changes in the merge request, including new issues and metrics such as complexity and duplication.

Merge request summary on GitLab

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.

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

Last modified March 18, 2022