YouTrack InCloud 2018.3 Help

YouTrack Integration Plugin

The YouTrack Integration Plugin extends the functionality of the Task Management plugin that is built into JetBrains IDEs. The plugin is available for use with all JetBrains IDEs. This includes AppCode, CLion, DataGrip, GoLand, IntelliJ IDEA, PhpStorm, PyCharm, Rider, RubyMine, and WebStorm. The plugin is also supported in Android Studio.

This plugin enables the following features in your IDE:

  • View a list of issues that match specific search criteria directly in your IDE.

  • Receive update notifications without switching to your email or Jabber client.

  • Enter a search query to locate a specific issue in the list.

  • Open an issue as a task to set the work context in your IDE.

  • Open a command dialog in your IDE to apply commands to issues in YouTrack.

  • Access YouTrack issues from the VCS history and comments in Java code. These references to issue IDs are automatically formatted as links to YouTrack. This mimics the functionality of the Issue Navigation plugin, so you don't have to enable it separately.

In addition, this plugin enables the Open in IDE feature in YouTrack.

The list of issues that is pulled from your YouTrack server is cached locally in your IDE. This means that you can view issues even when offline.

Install the YouTrack Integration Plugin

Perform this setup directly in your IDE. You do not need to configure anything in YouTrack. You can configure the plugin settings independently for different projects in your IDE.

To install the YouTrack Integration Plugin:

  1. Open a project in your IDE.

  2. Access the Plugin settings.
    • For Windows and Linux, open the Settings dialog and select Plugins.

    • For macOS, open the Preferences dialog and select Plugins.

  3. Click the Browse repositories button.

  4. Select the YouTrack Integration Plugin from the list.

    Youtrack integration plugin

  5. Click the Install button.
    • The plugin is installed in your IDE.

  6. Restart the IDE to apply changes for the plugin.
    • The YouTrack Integration Plugin is installed in your IDE.

To configure the YouTrack Integration Plugin:

  1. Select the YouTrack tool window. If your Tool Buttons menu is hidden, select View > Tool Window > YouTrack.

  2. Click the Configure link.

  3. Click the Add server button and select YouTrack.

    Youtrack integration add server

  4. Configure the connection to your YouTrack server:
    IDE integration configure server

    Setting

    Description

    Server URL

    Enter the URL of your YouTrack server.

    For YouTrack InCloud instances, be sure to include the trailing /youtrack. For example, https://writing.myjetbrains.com/youtrack.

    Username

    Enter the username of your YouTrack user account.

    If you use a permanent token for authentication, you can use any of the logins or email addresses that are stored in your Hub account, including credentials from third-party authentication modules like Google and GitHub.

    Password

    Enter the password for your YouTrack user account.

    Alternatively, you can generate a permanent token for your YouTrack account and paste the token into the Password input field. You can revoke a permanent token at any time, so they're safer to store in an IDE than a password. To learn how to generate a permanent token for YouTrack, see Create a Permanent Token.

    Search

    Enter a search query that returns the issues that you want to set as tasks in your IDE.

  5. Click the Test button to test the connection to the server.

  6. Select the Commit Message tab.

  7. Enter placeholders for issue properties to set the default text for your commit messages.

    Youtrack integration servers commit message

  8. Click the OK button.
    • Your IDE is configured to connect to your YouTrack server.

View Issues in the YouTrack Tool Window

The YouTrack Integration Plugin adds a YouTrack tool window to your IDE.

Youtrack issues tool window

The tool window is divided into two panes:

  • The left pane displays a list of issues that match the search criteria. You can edit this search query at any time in the input field at the top of the tool window. The list supports two levels of detail.
    • In one-line view, you see the issue priority, ID, summary, and the date and time of the last update.

    • In compact view, the values for custom fields are also displayed.

  • The right pane displays the issue detail. Here, you can find the issue ID, summary, tags, issue links, issue description, comments, and attachments. Descriptions and comments in YouTrack Wiki markup are rendered as shown in YouTrack.

The toolbar to the left of the tool window provides access to the following actions:

Action

Description

Refresh

Pulls updates from your YouTrack server. All issues that match the search query are displayed in the tool window.

Add Comment

Opens the Apply Command dialog with the comment command. To add a comment to the selected issue, enter your comment text and click Apply or Silent Apply.

Open Command Window

Opens the Apply Command dialog. Here, you can enter a command to update an issue. For a complete list of commands, see Command Reference.

Open Task

Sets the selected issue as the active task. All of the changes that you make in the code are associated with the issue that is selected as the current task.

Copy Issue Link

Copies the URL of the selected issue to the clipboard.

Open in Browser

Opens the selected issue in your default web browser.

Analyze Stacktrace

Opens a stacktrace from the issue description in the Analyze Stacktrace dialog.

Pin Issue

Opens the selected issue in a separate tool window tab. To remove the pinned issue, right-click the tool window tab and select Close Tab.

Toggle Presentation

Expands and collapses the list of issues in the tool window. The two views that are supported in the tool window are similar to the One-line view and Compact view settings on the Issues list in YouTrack.

Configure Servers

Opens the Servers settings dialog. Here, you can modify the search criteria, add another YouTrack server, or modify your default commit message.

Get Issue Notifications

If notifications via REST API are enabled in YouTrack, you can receive update notifications directly in your IDE. This means that you can stay up to date on all of your issues without switching to your email or Jabber client.

Ide integration notifications

The notifications that are posted to your IDE are based on your personal notification preferences that are configured on the Notifications tab in your user profile. For more information, see Notifications.

The following actions are available for each notification:

Action

Description

Browse

Opens the issue for which the notification was sent in your web browser.

Dismiss

When selected in the notification popup, the notification balloon closes. When selected in the Event Log tool window, the notification links are disabled.

Configure Notifications

Opens the Notifications setting in your YouTrack profile. Here, you can modify your general notification scheme and update your subscriptions.

The appearance and behavior of these notifications is dictated by the notification settings in your IDE. These settings determine whether the notifications are shown as balloon notifications and how the notifications are presented. To learn more about these settings, refer to the documentation for your IDE. For JetBrains IDEs, the notification settings are similar to the options that are described in the documentation for IntelliJ IDEA.

Search for Issues in the List

To search for a specific issue, select the tool window and start typing. The first issue that matches your search query is highlighted in the list.

Youtrack issues tool window search

Open Issues as Tasks in Your IDE

Like the Task Management integration, the YouTrack Integration Plugin lets you open an issue as a task and set your current work context.

To define the work context:

  1. Open the YouTrack tool window.

  2. Select an issue from the list.

  3. Click the Open Task icon.

  4. Set the parameters for the new task.
    Ide open task parameters
    The following options are supported for task management:

    Option

    Description

    Update issue state

    When enabled, updates the value for a custom field that stores a state type to the selected value in the drop-down list.

    Clear current context

    When enabled, clears the current context.

    If your project is connected to a version control system, a set of options for VCS operations are also available. These options vary by version control system. For additional information, refer to the documentation for your IDE.

  5. Click the OK button.
    • The new task is set as your work context.

    • The active task is marked with a star icon in the issue list.

Apply Commands to Issues

The YouTrack Integration Plugin lets you apply commands to issues directly from your IDE. To open the Apply Command dialog in your IDE:

  • Click the Execute YouTrack command button in the toolbar.

  • Press Ctrl + Shift + Y ( + Shift + Y on macOS).

Youtrack integration command window

The Apply Command dialog works exactly as it does in YouTrack. For more information, see Commands.

Open Stacktraces in Your IDE

YouTrack automatically recognizes and formats Java and C# stacktraces that are inserted into an issue description or comment.

Java stack trace

When the stacktrace is formatted, references to source code and other issues are set as links. Click these links to open the target reference in your IDE.

Last modified: 16 November 2018