YouTrack InCloud 2021.4 Help

Integrate with Space

Follow the instructions on this page to integrate your project with VCS repositories that are hosted on JetBrains Space.

A Space 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 the issue in YouTrack. For more information, see Commits.

  • Add links to the Space repository by pasting commit hashes into the issue summary, description, comment, or a supplemental text field.

Prerequisites

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

Configure an Application for YouTrack in Space

To connect YouTrack to Space, you need to register and configure an application in Space.

To register and configure an application for YouTrack in Space:

  1. In Space, click Administration on the navigation bar and choose Applications.

    Space applications
  2. Click the New application button.

    New Space application
  3. Give your application a unique name and click Create.

  4. In the application settings, open the Requested Rights tab and select the following rights:

    • In the Project category: View project data.

    • In the Git Repositories category: Read, Write, and Admin.

  5. In the application settings, open the Authentication tab, select the Client Credentials flow as the authentication flow, and click Save.

    Space application authentication settings
  6. On the top of the Authentication tab, you'll find the client ID and secret that you'll need for the integration settings in YouTrack. Prepare to copy the client ID and secret to YouTrack.

If you already have an application for YouTrack in Space, make sure that its configuration matches the recommended one and prepare to copy its client ID and secret to YouTrack.

Connect to a Repository

The first step is to establish a connection between a project in YouTrack and a repository in Space. To connect with Space, you need the client ID and secret from the application settings in Space. These credentials allow YouTrack to access the repository according to the rights granted to the application in Space.

To connect to a Space repository:

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

  2. From the Administration menu for your project, select VCS.

    project administration VCS integration
  3. Click the New VCS Integration  button.

    • The New VCS Integration dialog opens.

      new Space VCS integration
  4. For the Server type, select Space.

  5. Paste the URL that points to your Space repository into the Repository URL input field.

  6. Paste the client ID from Space into the Application client ID input field.

  7. Paste the client secret from Space into the Application client secret input field.

  8. Click the Save button.

    • Your YouTrack project is integrated with the selected repository in Space.

    • Commits from the Space 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.

      Space integration settings

If you already have an application for YouTrack in Space, make sure that its configuration matches the recommended one and prepare to copy its client ID and secret to YouTrack.

Integration Settings

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:

Setting

Description

Repository

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.

Additional projects

Integrates the linked repository with one or more additional projects.

Committers

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:

  • Add commits, ignore commands: Add VCS changes to issues when a commit message references an ID that belongs to an issue in an integrated project. Any command in the commit message is ignored.

  • Add commits in all projects, apply commands in main: Add VCS changes to issues when a commit message references an ID that belongs to an issue in an integrated project. Only apply commands to issues that belong to the currently selected main project.

  • Add commits and apply commands to all projects: Add VCS changes to issues when a commit message references an ID that belongs to an issue in an integrated project. Update issues in any integrated project when commit messages include commands.

Monitored branches

Stores the names of the branches that you want to monitor for changes.

  • Use + to include a branch.

  • Use - exclude a branch.

  • For the branch name, use the fully qualified name of the branch. For example, refs/heads/<branch name>.

  • Use * as a wildcard. This placeholder matches one or more characters in a string. For example, to include all feature branches, use:

    +:refs/heads/feature/*
  • To monitor all branches, leave the input field empty.

If the address that you entered as the Repository URL when you connected to GitHub 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:

  • 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

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.

Available Actions

When you select an integrated version control system in the list, the following actions are available in the toolbar:

Action

Description

Disable

Shuts off the connection between the integrated project and the VCS repository. The configuration is not changed and can be enabled at any time.

Edit

Opens the integration settings dialog in the sidebar for the selected project and repository.

Delete

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.

Last modified: 14 October 2021