YouTrack InCloud 2019.2 Help

Integrate with Jenkins

Follow the instructions on this page to integrate your YouTrack project with a job in Jenkins. The integration between YouTrack and Jenkins enables the following features in your project:

  • Pull build numbers from connected projects and automatically update the values in custom fields that store build numbers for resolved issues.

  • Add VCS change records to issues that are mentioned commit messages. To learn more about VCS changes in YouTrack issues, see View and Edit VCS Changes.

  • Apply commands to issues in commit messages when TeamCity assembles a build that contains the commit. To learn how to format commands in commit messages, see Apply Commands in VCS Commits.

Prerequisites

Before you start, verify the following requirements:

  • You have a Jenkins installation that runs version 1.651.3 (1.x branch) or 2.15 (2.x branch) or later.

  • Your Jenkins account has read access for the views that contain the jobs that you want to connect to YouTrack.

  • The YouTrack project that you want to integrate with Jenkins uses a custom field that stores a value as a build type. You can use the default custom field Fixed in build or any other custom field that stores a build type.

    If you don't want to add build numbers to issues, you can enable the integration without mapping build numbers to a custom field in YouTrack. In this case, your developers can still mention issues and apply commands in VCS commit messages.

  • To map VCS usernames in the linked repository to user accounts in YouTrack, the project in Jenkins must be configured to use the commit author in the changelog. Use the following navigation path to locate this setting: Project > Configure > Source Code Management > Additional Behaviours > Use Commit Author In Changelog.

  • To enable linking from VCS changes that are shown in issue view to a diff, you need to install the Last Changes plugin in Jenkins.

Connect to a Jenkins Server

To enable the integration in your project, YouTrack needs a connection to at least one Jenkins server. If you have sufficient permissions in Jenkins, you can establish the connection yourself.

If you don't have these permissions in Jenkins, a YouTrack administrator can configure the connection. For details, see Jenkins Integration.

If YouTrack is already integrated with the Jenkins server that processes builds that contain references to your project, skip this step and define the mapping for your project.

To connect to a Jenkins server:

  1. Click the Projects link in the header to open the Projects list.

  2. From the Administration menu for your project, select Build Server Integration.

    project administration build server integration

  3. From the Add New Mapping menu, select Add build server.

    add build server in project
    • The Add Build Server dialog opens in the sidebar.

    add Jenkins server
  4. Enter values for the following settings:

    Setting

    Description

    URL

    Enter the URL of the Jenkins server.

    Type

    Select Jenkins.

    Login

    Enter the username of the Jenkins user account.

    Password

    Enter the password for the Jenkins user account.

  5. Expand the Advanced settings section and configure the following optional settings:

    Setting

    Description

    SSL key

    If the Jenkins server uses a secure connection and you have uploaded an SSL client key to authenticate your YouTrack service, select the client key from the drop-down list. For more information, see SSL Keys.

    Socket timeout

    Set the maximum amount of time to wait for a response from the Jenkins server before disconnecting the socket. The default is 30 seconds.

    Read timeout

    Set the maximum amount of time to wait for complete data transfer from the Jenkins server before closing the connection. The default is 30 seconds.

  6. Click the Test connection button.

    • YouTrack verifies the connection to the Jenkins server.

  7. Click the Add server button.

    • The Jenkins server connection settings are saved.

Repeat these steps to add connections to additional Jenkins servers.

Define the Mapping between Projects

To enable the Jenkins integration in your project, you map your YouTrack project to a job in Jenkins.

The first group of settings connect YouTrack to a job for a project on a Jenkins server. Additional options for the default branch let you define which issues are assigned build numbers. You can also specify the commands to apply to all of the issues that are processed by YouTrack.

To define a mapping between YouTrack and Jenkins:

  1. On the Build Server Integration tab of the Edit Project page, select a Jenkins server in the list of build server integrations.

  2. Click the Create New Mapping button.

    • The Create Mapping dialog opens in the sidebar.

    new Jenkins mapping
  3. Enter values for the following settings:

    Setting

    Description

    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 Job

    Select the job in the Jenkins project.

    Process changes

    Choose how YouTrack handles VCS changes in builds that are processed by Jenkins. The following options are available:

    • Do not attach — VCS changes that include references to YouTrack issue IDs are not added to the activity stream in the referenced issue. Use this option when you only want the integration to add build numbers to custom fields.

    • Attach — 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. The commit message is not parsed for YouTrack commands.

    • Attach and apply commands — 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. The commit message is also parsed for YouTrack commands.

    Visible to

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

    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:

    • 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.

    If you don't want to add build numbers to issues, continue from step 8.

  4. Click to expand the Actions for Default Branch settings. These settings determine which actions are applied to builds in the default branch.

    actions for default branch

  5. Configure the options in the Process section of the form. These options determine which builds are processed by the integration and which issues are assigned build numbers.

    Option

    Description

    Failed builds

    Adds build numbers to issues for all builds, including failed builds. When disabled, only successful builds are added to issues in YouTrack.

    Add each build

    Determines which build numbers are added to the set of values for the custom field that is stored in the Build field setting. Enable to add builds to the set of values in the build field even when there aren't any YouTrack issues that were processed in the build. The builds that are considered for this option are affected by the Failed builds setting.

    Related issues

    Adds build numbers to issues that are mentioned in commits and build comments. When disabled, YouTrack ignores mentioned issues.

    Use this option together with the Issues matching query setting to determine which issues are assigned build numbers.

    Issues matching query

    Adds build numbers to issues that match a specific filter criteria. The standard search query is State: Fixed State: Verified resolved date: ${build.time}..${prev.build.time}. This query ensures that only issues that are resolved since the last successful build and the current build are considered.

    Use this setting together with the Related issues option to determine which issues are assigned build numbers.

  6. For the Build field, choose the custom field in your project that stores build numbers from Jenkins. The selection is restricted to custom fields that store a build type.

  7. In the Apply command field, enter an optional command to apply to all issues that are assigned build numbers in YouTrack. 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.

  8. Click the Create mapping button.

    • The YouTrack project is mapped to the selected project in Jenkins.

    • The Jenkins integration is enabled and available for use in your YouTrack project.

Placeholders

You can use placeholders in the Query and Command settings. These placeholders reference attributes that are stored for builds in Jenkins. The placeholder is replaced with the corresponding value in the connected version control system when the builds are processed by YouTrack. The following placeholders are available:

Placeholder

Description

${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.

${revision}

The revision number that is assigned to a VCS commit.

Last modified: 10 July 2019

See Also