If your server is accessible from the public internet, use the following instructions.

1. Create a GitLab App within your GitLab organization

In GitLab, go to your User Settings -> Applications

  • Add an app name - this can be anything

  • Enter the text below as the ‘Redirect URI’
    https://velocity.codeclimate.com/settings/vcs/auth/callback

Select the following scope options:

  • api (Access the authenticated user's API)
    • We require write access to the API so that we can install webhooks.

  • read_user (Read the authenticated user's personal information)

  • read_repository (Allows read-only access to the repository)

  • read_registry (Grants permission to read container registry images)

  • openid (Authenticate using OpenID Connect)

  • profile (Allows read-only access to the user's personal information using OpenID Connect)

  • email (Allows read-only access to the user's primary email address using OpenID Connect)

Click ‘Save application’, and note the ‘Application ID’ and ‘Secret’ fields for use when setting up the VCS in Velocity.

2. Create VCS in Velocity

In Velocity, go to Velocity -> Settings -> VCS -> ‘Add version control system’

  • Select ‘GitLab’ as the VCS type

  • Enter the GitLab host name - for example, ‘gitlab.company-name.net’

  • Enter the ‘Application ID’ from the GitLab application in the ‘OAuth client ID’ field

  • Enter the ‘Secret’ from the GitLab application in the ‘OAuth client secret’ field

  • Click ‘Create version control system’

3. Contact Code Climate confirming the VCS creation. 🎉

We will update our agents accordingly so you can connect to the new VCS.

Did this answer your question?