Integrate with GitLab
Follow the instructions on this page to integrate your project with VCS repositories that are hosted on gitlab.com, self-hosted GitLab Community Edition (CE), or self-hosted GitLab Enterprise Edition (EE) server.
A GitLab integration enables the following features in YouTrack:
Apply commands to YouTrack issues in commit messages. For more information, see Apply Commands in VCS Commits.
Track commits that are related to specific issues in the activity stream for each issue. For more information, see Commits.
Display the status of pull (merge) requests directly in the activity stream of any issue that is referenced in the title or description of the pull request. For details, see Pull Requests.
Add links to YouTrack issues in commit messages or branch names. For more information, see Link Issues in VCS Commits.
YouTrack is accessible to inbound connections. Specifically, you need to make sure that your network doesn't block connections between your VCS server and YouTrack.
The account that you use to connect to GitLab has access to the GitLab project that you want to manage with this integration. This is the user account whose private token is used for authentication. You can either use an account that has at least Master or Owner access level in the project or a GitLab administrator account.
If you're integrating with a GitLab CE or GitLab EE installation and want to establish a secure (HTTPS) connection with the server, you may need to import the SSL certificate for your GitLab server into YouTrack.
If your GitLab server has a valid certificate that is signed by a well-known certificate authority (CA), the JVM vendor may have already added the root (CA) certificate to the certificate store. You should be able to connect to the server without importing its SSL certificate.
If the certificate for your server is self-signed, you need to import the certificate and public key to establish a secure connection. For security, use this option only when both YouTrack and your GitLab server run on a private computer network. This operation is only available to users with Low-level Admin Read and Low-level Admin Write permissions. For details, see SSL Certificates.
Enable the YouTrack Integration in GitLab
The first thing you should do is enable the YouTrack integration in GitLab. This formats references to YouTrack issues in commit messages as links to the target issues in YouTrack. The following limitations apply:
This functionality is supported in GitLab versions 11.9.0 and later.
The integration only recognizes issue prefixes that begin with an uppercase letter. Issue prefixes that begin with lowercase letters or numeric values are not recognized.
To learn more about this integration, refer to the GitLab Docs.
To enable the YouTrack Integration:
Access the project that you want to integrate with in GitLab.
From the Settings menu, select Integrations.
In the Project services section of the page, select YouTrack
Specify values for the following settings:
Enter any value. Use this setting to indicate which YouTrack service you've integrated with.
Enter the base URL for your YouTrack service.
For YouTrack InCloud instances hosted on
myjetbrains.com, your base URL includes the trailing
YouTrack issues aren't accessible from URLs that end in a project name. Don't attempt to add the project name or ID to the URL.
Enter your base URL, followed by
Enable the Active option.
Click the Test settings and save changes button.
With this configuration, any reference that is recognized as an issue in YouTrack is set as a link.
The link is formed according to the pattern that is set for the Issues url.
:idplaceholder is replaced with the issue ID, which includes the project prefix.
This means that you can add links in GitLab to any issue in any project from your YouTrack installation, even when you haven't configured an integration for the project in YouTrack. However, related VCS changes are only shown in issues where the GitLab integration has been set up for the project in YouTrack. To enable this integration feature, continue with the setup as described in the following section.
Configure the GitLab Integration
Next, you need to establish a connection between a project in YouTrack and a repository in GitLab. To connect with GitLab, you need to generate and store a personal access token. This token grants YouTrack access to the repository based on the access that is granted to your GitLab account.
You can use a single access token to set up multiple integrations. If you don't already have a personal access token, you can use the direct link from YouTrack to generate it during this setup procedure.
To connect to a GitLab repository:
Click the Projects link in the header to open the Projects list.
From the action menu for your project, select VCS.
Click the New VCS Integration button.
The New VCS Integration dialog opens.
For the Server type, select GitLab.
Paste the URL that points to your GitLab repository into the Repository URL input field.
Paste your personal access token into the Personal access token input field. If you don't already have an access token, follow these steps:
Click the Generate token link to open the Personal Access Tokens page in GitLab.
Enter a name for the token.
Set the Scopes for the token. The VCS integration requires
Click the Create personal access token button.
Copy the token to the clipboard.
Switch back to the New VCS Integration dialog in YouTrack and paste the token into the Personal access token field.
Click the Save button.
Your YouTrack project is integrated with the selected repository in GitLab.
Commits from the GitLab repository that reference an issue in the project are displayed in the activity stream of the referenced issue.
The sidebar displays additional settings for configuring the VCS integration.
To learn more about these settings, see Integration Settings.
Advanced Server Settings
If you are unable to establish a connection to your repository using the basic settings on the New VCS Integration dialog, click the Show advanced server settings link.
You only need to enter values for these settings when you haven't set up a VCS integration with the target server. If you already have a working integration with a single repository on the server, you can add integrations with other repositories without setting these parameters again.
Use the following guidelines to set the values for these settings:
This setting helps to identify the path to the GitLab repository. If the repositories for your GitLab CE or EE server are available under
To resolve this problem, enter the base URL for your GitLab server plus the context path that points to your repository. For example:
If your server environment is set up to require client SSL authentication, select the keystore that contains the private key for your YouTrack server. This key identifies your YouTrack server when it tries to establish a connection with GitLab. This setting is only used to support HTTPS authentication as required by connections to your internal network.
The list only displays SSL keys that are already imported into YouTrack. To learn how to generate keystores files and upload them to YouTrack, see SSL Keys.
By default, the VCS integration processes changes that are committed to the repository by any user in any branch. Any user who has access to the issue in YouTrack can view these changes in the issue activity stream.
If you only want to process changes by specific users in designated branches or restrict the visibility of VCS changes in YouTrack, you can customize the integration settings. Use following settings to customize the integration:
Displays the path to the repository in the integrated version control system.
If needed, you can edit the location of the repository after you have set up the integration. For instructions, see Edit Repository Settings.
Integrates the linked repository with one or more additional projects.
The list is restricted to only show projects where you have the Update Project permission.
Restricts the ability to update issues with commands in commit messages to members of the specified group. VCS changes from users who are not members of the selected group are still attached to related issues, but any commands that are specified in their commits are ignored.
Processing scheme for VCS changes
Select the way how YouTrack processes VCS changes with commit message that references ID of an issue. The following options are supported:
Stores the names of the branches that you want to monitor for changes.
If the address that you entered as the Repository URL when you connected to GitLab points to a specific branch, this branch is automatically added to the list of monitored branches when you set up the connection.
Parse commits for issue comments
When enabled, specific segments of commit message text are copied to issues as comments. When you copy parts of the commit message to the issue as comments, you can trigger @mention notifications and expose information to users who don't have access to VCS changes.
This setting does not affect how commit messages are shown in VCS changes. The entire commit message, including commands and issue comments, is always shown as part of the VCS change record in the activity stream.
You should only enable this option when:
To learn more about how YouTrack processes commit messages, see Apply Commands in VCS Commits.
VCS changes visibility
Restricts the visibility of VCS changes to one or more groups of users in YouTrack. When unrestricted, the list of VCS changes is visible to any user who has permission to read the issue.
When you select an integrated version control system in the list, the following actions are available in the toolbar:
Shuts off the connection between the integrated project and the VCS repository. The configuration is not changed and can be enabled at any time.
Opens the integration settings dialog in the sidebar for the selected project and repository.
Removes the settings for the integrated project from YouTrack.
This action also removes all VCS changes that were added to issues for commits in the linked repository.
While the action itself cannot be undone, you can use the Import action to restore VCS changes that were removed accidentally.
Import commits and open pull requests
Checks the commit history in the linked repository and adds VCS changes to issues that are referenced in commit messages. This option is only available for integrations that are currently enabled.
You can use this action to restore VCS changes that were removed when an integration was accidentally deleted or to migrate links to issues in a new project.
Condition — References to issues in VCS commits are not shown as VCS changes in YouTrack.
The webhooks in the integrated VCS don't exist, are disabled, or are otherwise malformed.
Check the webhooks in the settings for your VCS repository. Make sure that the webhooks exist and that they are enabled.
If you suspect that there is a problem with a webhook, delete or disable it in the settings for your VCS and set up a new VCS integration in YouTrack.
Condition — Commands that are specified in VCS commits are not applied to issues in YouTrack.
The users who commit changes to the repository are not members of the Committers group in the integration settings.
Either add the committers to the specified group in YouTrack or modify the selection in the integration settings.
The users who commit changes to the repository do not have permission to update issues in the connected project.
Either add these users to the project team or grant them a role in the project that includes the Read Issue and Update Issue permissions.
YouTrack can't find a user account that matches the author of the commit message.
The user must either use the same email address for their accounts in both YouTrack and GitLab or add the value that is stored as the Name in their GitLab profile to the list of VCS usernames in their Hub accounts.
For more information, see Match Change Authors and YouTrack Users.
Condition — You are unable to connect to your GitLab repository. Follow the instructions below to resolve the problem.
The user whose personal access token is used for authentication with GitLab does not have access to any projects in GitLab.
Access the Members settings for your GitLab project and add this user to the project. You can also share the project with a group where this user is a member.
This user does not require a specific access level — Guest access is sufficient.
Condition — You are unable to establish a connection between YouTrack and your GitLab CE/EE server. See if any of the following causes are present.
The external service is unavailable.
Verify that your GitLab server is running.
The connection is blocked by a firewall.
Open the ports in the firewall that are used by YouTrack and the GitLab server.
The GitLab server requires a secure connection.
Import the certificate for your GitLab server into YouTrack. For instructions, see SSL Certificates.
Your SSL certificate for the GitLab server has expired.
Renew and import the updated certificate into YouTrack. For instructions, see SSL Certificates.