redmine.md 2.09 KB
Newer Older
1 2
# Redmine Service

3
1. To enable the Redmine integration in a project, navigate to the
4
   [Integrations page](overview.md#accessing-integrations), click
5 6
   the **Redmine** service, and fill in the required details on the page as described
   in the table below.
7

8 9 10 11 12 13
   | Field | Description |
   | ----- | ----------- |
   | `description`   | A name for the issue tracker (to differentiate between instances, for example) |
   | `project_url`   | The URL to the project in Redmine which is being linked to this GitLab project |
   | `issues_url`    | The URL to the issue in Redmine 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. |
   | `new_issue_url` | This is the URL to create a new issue in Redmine for the project linked to this GitLab project. **This is currently not being used and will be removed in a future release.** |
14

15
   Once you have configured and enabled Redmine you'll see the Redmine link on the GitLab project pages that takes you to the appropriate Redmine project.
16

17
   As an example, below is a configuration for a project named `gitlab-ci`.
18

19
   ![Redmine configuration](img/redmine_configuration.png)
20

21
1. To disable the internal issue tracking system in a project, navigate to the General page, expand the [permissions](../settings/index.md#sharing-and-permissions) section and switch the **Issues** toggle to disabled.
22 23 24 25

## Referencing issues in Redmine

Issues in Redmine can be referenced in two alternative ways:
26 27 28

- `#<ID>` where `<ID>` is a number (example `#143`).
- `<PROJECT>-<ID>` where `<PROJECT>` starts with a capital letter which is
29 30 31
  then followed by capital letters, numbers or underscores, and `<ID>` is
  a number (example `API_32-143`).

32 33
We suggest using the longer format if you have both internal and external issue trackers enabled. If you use the shorter format and an issue with the same ID exists in the internal issue tracker the internal issue will be linked.

34 35
Please note that `<PROJECT>` part is ignored and links always point to the
address specified in `issues_url`.