Jenkins Integration

Main YouTrack project

Select the YouTrack primary project that you want to map to a project in Jenkins.

Additional projects

Integrates the linked build server with one or more additional projects.

Jenkins server

Select the Jenkins server that contains the project that you want to map to. If you are only connected to one Jenkins server, it is set by default.

Jenkins view

Select the name of the view that includes the Jenkins project.

Jenkins project

Select the Jenkins project.

Check branch names for issue references

When enabled, the integration checks for references to issues in branch names for commits and pull requests. This option is included for teams that use a branch-per-ticket process, so their developers don't have to mention issue IDs in their commit messages explicitly.

VCS integration

Determines whether the integration adds VCS change records to and processes commands for issues that are referenced in commit messages.

• When Enabled, VCS changes that include references to YouTrack issue IDs are added to the activity stream in the referenced issue. The entry in the activity stream contains a link to the build that contains the change.

• When Disabled, the integration ignores all commits to the repository that is connected to the build server.

  Disable this option when you only want the integration to add build numbers to custom fields or have already configured an integration with the VCS directly.

Apply commands to issues

Determines whether commit messages are also parsed for YouTrack commands. When enabled, YouTrack applies any command that is specified in a commit message that is included in the assembled build to the corresponding issue.

This option is only available when the VCS integration setting is Enabled. When enabled, you can select whether commands are applied to issues in all integrated projects, or the main project only.

Parse commits for issue comments

When enabled, specific lines of text in commit messages 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:

• You want to mention other users in your commit messages and generate notifications when the text is copied to an issue comment.

• You restrict the visibility for VCS changes and want to make commit-related information visible to external users as comments.

To learn more about how YouTrack processes commit messages, see Apply Commands in VCS Commits.

VCS changes visibility

To restrict the visibility of comments and updates that are shown as VCS changes in the activity stream, select one or more groups or teams from the list. Otherwise, this activity type is visible to any user who has sufficient access to read the issue.

Pull data from assembled builds

Determines whether the integration listens for all builds that are assembled by the build server, excludes canceled builds, or only considers successful builds.

Add build numbers 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.

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 builds that don't reference any issues ⏤ Determines whether all builds that are processed by the integration or only those that contain references to YouTrack issues. The builds 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 or branch names that match the following search criteria ⏤ Determines how the integration handles issues that contain references in commit messages or branch names.

  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 build number in Jenkins. 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.

${build.time}

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

${prev.build.time}

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

${build}

The number of the build that is processed by YouTrack.