GitLab CI/CD Integration

Pull data from finished job

Determines whether the integration listens for all jobs finished by GitLab CI/CD or only considers successful ones.

Add pipeline IDs to the set of values in a custom field

Determines which custom field is populated with build numbers in the integrated YouTrack project. The selection is restricted to custom fields that store a build type.

As GitLab CI/CD operates with pipelines instead of builds, YouTrack stores pipeline IDs instead of build numbers as custom field values.

The value for the selected field is set automatically in any issue that is updated by the integration. The settings in the Select which issues to update section of the integration determine which issues are assigned build numbers.

The following option is available:

• Include pipelines that don't reference any issues ⏤ Determines whether all pipelines are processed by the integration or only those that contain references to YouTrack issues. The pipelines that are considered for this option are affected by the Pull data from assembled build setting.

  When you enable this option, users can manually adjust the build numbers in issues without having to manually add the build number first.

Select which issues to update

The options in this section determine which issues are assigned build numbers by the integration. The following options are available:

• Update issues referenced in commit messages, branch names, or build comments that match the following search criteria ⏤ Determines how the integration handles issues that contain references in commit messages, branch names, or build comments.

  Use the query input field to filter out any issues with mentions that you want to exclude from automatic build number assignment. If the option to update issues referenced in commit messages is deselected, the filter is ignored as well.

• Update any issue that matches the following search criteria ⏤ Determines which issues are assigned build numbers whether they contain issue references or not.

  The standard search criteria are:

  State: Fixed State: Verified resolved date: ${prev.build.time} .. ${build.time}

  This query ensures that only issues that are resolved since the last successful build and the current build are considered.

  If the option to update issues that match the search criteria is deselected, the query is ignored as well.

If both options are enabled, build numbers are automatically assigned to issues that meet either of these two conditions.

Update selected issues

Determines whether the integration applies changes to the selected issues in addition to the automatic build number assignment. When the Apply a command option is enabled, you can enter a predefined command that is applied to all issues that are assigned build numbers.

Use the ${build} variable to reference the pipeline ID in GitLab CI/CD. For example:

Subsystem Testing Test in build ${build}

With this command, all issues that are processed by YouTrack are assigned to the Testing subsystem and the Test in build field is set to the build number.

Edit

Opens the Edit Job Name dialog where you can edit the name of the integration job.

Remove

Removes the integration job from YouTrack. All changes made by the integration remain in place.

${build.time}

The date and time of the job that is processed by YouTrack.

${prev.build.time}

The date and time of the job prior to the one that is processed by YouTrack.

${build}

The ID of the pipeline with the job that is processed by YouTrack.

The webhook that connects to GitLab isn't configured to check for relevant activity or the user account that is used to establish the connection has insufficient permissions.

Select the VCS integration in the list and click the Disable button. Once the integration has been disabled, click the Enable button.

This operation has two outcomes:

• If there was a problem with the existing webhook, it is reconfigured automatically.

• The personal access token use to authenticate with GitLab is validated. If the token has insufficient permissions, generate another token that is granted the required permission scopes.

An issue mentioned in a commit message does not match the query in the integration settings.

Adjust the query in the settings or make the related issue match the existing query.

The name of the job in the YAML configuration file in GitLab doesn't match any job in the integration settings.

Change the job name in the integration settings to match the name of the job in GitLab CI/CD. Alternatively, add a new integration job with the name matching a GitLab CI/CD job.