This documentation is a preview of the pull request #2253

For the latest updates and improvements in production, open docs.codacy.com instead.

GitLab Cloud

Follow the instructions below to set up the Codacy Self-hosted integration with GitLab Cloud.

Create a GitLab application

To integrate Codacy with GitLab Cloud, you must create a GitLab application:

1. Open https://gitlab.com/-/profile/applications.

2. Fill in the fields to register your Codacy instance on GitLab:

   • Name: Name of the application. For example, Codacy.

   • Redirect URI: Copy the URLs below, replacing the HTTP protocol and hostname with the correct values for your Codacy instance. This field is case sensitive.

     https://codacy.example.com/login/GitLab
     https://codacy.example.com/add/addProvider/GitLab
     https://codacy.example.com/add/addService/GitLab
     https://codacy.example.com/add/addPermissions/GitLab
     

   • Scopes: Enable the scopes:

     • api
     • read_user
     • read_repository
     • openid

   

3. Click Save application and take note of the generated Application Id and Secret.

Note

You can ignore the following error that GitLab may display when you test or save the new GitLab application:

This happens because GitLab tests the new application by calling an endpoint that Codacy doesn't implement.

Configure GitLab Cloud on Codacy

After creating the GitLab application, you must configure it on Codacy:

1. Edit the file values-production.yaml that you used to install Codacy.

2. Set global.gitlab.enabled: "true" and define the remaining values as described below using the information obtained when you created the GitLab application:

   gitlab:
     enabled: "true"
     login: "true" # Show login button for GitLab Cloud
     clientId: "" # Application ID
     clientSecret: "" # Secret
   

3. Apply the new configuration by performing a Helm upgrade. To do so execute the command used to install Codacy:

   Important

   If you're using MicroK8s you must use the file values-microk8s.yaml together with the file values-production.yaml.

   To do this, uncomment the last line before running the helm upgrade command below.

   helm upgrade (...options used to install Codacy...) \
                --version 14.0.0 \
                --values values-production.yaml \
                # --values values-microk8s.yaml
   

After this is done you will be able to use GitLab Cloud to authenticate to Codacy.

Share your feedback 📢

Did this page help you?

Yes No

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

Send 255 characters left

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

Send 255 characters left

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 25, 2023