youtrack.md 2.7 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

7
## Enable the YouTrack integration
M
Mike Lewis 已提交
8

9
To enable YouTrack integration in a project:
Y
Yauhen Kotau 已提交
10

11 12
1. Navigate to the project's **Settings > [Integrations](project_services.md#accessing-the-project-services)** page.
1. Click the **YouTrack** service, ensure it's active, and enter the required details on the page as described in the table below.
Y
Yauhen Kotau 已提交
13

14 15 16 17 18
    | Field           | Description                                                                                                                                                                                                 |
    |:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    | **Description** | Name for the issue tracker (to differentiate between instances, for example).                                                                                                                               |
    | **Project url** | URL to the project in YouTrack which is being linked to this GitLab project.                                                                                                                                |
    | **Issues url**  | 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
1. Click the **Save changes** button.
Y
Yauhen Kotau 已提交
21

22
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.
Y
Yauhen Kotau 已提交
23

24 25 26 27 28 29
## Disable the internal issue tracker

To disable the internal issue tracker in a project:

1. Navigate to the project's **Settings > General** page.
1. Expand the [permissions section](../settings/index.md#sharing-and-permissions) and switch the **Issues** toggle to disabled.
Y
Yauhen Kotau 已提交
30

M
Mike Lewis 已提交
31
## Referencing YouTrack issues in GitLab
Y
Yauhen Kotau 已提交
32

M
Mike Lewis 已提交
33 34 35
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 已提交
36

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