youtrack.md 1.9 KB
Newer Older
Y
Yauhen Kotau 已提交
1 2
# YouTrack Service

M
Mike Lewis 已提交
3
JetBrains [YouTrack](https://www.jetbrains.com/help/youtrack/standalone/YouTrack-Documentation.html) is a web-based issue tracking and project management platform.
4

M
Mike Lewis 已提交
5
You can configure YouTrack as an [External Issue Tracker](../../../integration/external-issue-tracker.md) in GitLab.
6

M
Mike Lewis 已提交
7 8 9 10
## Enable the YouTrack integration in a project

Navigate to the [Integrations page](project_services.md#accessing-the-project-services), click
the **YouTrack** service, and enter the required details on the page as described
Y
Yauhen Kotau 已提交
11 12 13 14 15 16 17 18
in the table below.

    | Field | Description |
    | ----- | ----------- |
    | `description`   | A name for the issue tracker (to differentiate between instances, for example) |
    | `project_url`   | The URL to the project in YouTrack which is being linked to this GitLab project |
    | `issues_url`    | The URL to the issue in YouTrack project that is linked to this GitLab project. Note that the `issues_url` requires `:id` in the URL. This ID is used by GitLab as a placeholder to replace the issue number. |

M
Mike Lewis 已提交
19 20 21
Once you have configured and enabled YouTrack you'll see the YouTrack link on the GitLab project pages that takes you to the appropriate YouTrack project.

## Disable the internal issue tracker in a project
Y
Yauhen Kotau 已提交
22

M
Mike Lewis 已提交
23
Navigate to the General page, expand [Permissions](../settings/index.md#sharing-and-permissions), and switch the Issues toggle to disabled.
Y
Yauhen Kotau 已提交
24

M
Mike Lewis 已提交
25
![Issue configuration](img/issue_configuration.png)
Y
Yauhen Kotau 已提交
26

M
Mike Lewis 已提交
27
## Referencing YouTrack issues in GitLab
Y
Yauhen Kotau 已提交
28

M
Mike Lewis 已提交
29 30 31
Issues in YouTrack can be referenced as `<PROJECT>-<ID>`. `<PROJECT>`
must start with a capital letter and can then be followed by capital or lower case
letters, numbers or underscores. `<ID>` is a number. An example reference is `YT-101` or `Api_32-143`.
Y
Yauhen Kotau 已提交
32

M
Mike Lewis 已提交
33 34
References to <PROJECT>-<ID> in merge requests, commits, or comments are automatically linked to the YouTrack issue URL.
For more information, see the [External Issue Tracker](../../../integration/external-issue-tracker.md) documentation.