debian-mirror-gitlab/doc/user/project/integrations/custom_issue_tracker.md

26 lines
1.8 KiB
Markdown
Raw Normal View History

2018-03-17 18:26:18 +05:30
# Custom Issue Tracker Service
To enable the Custom Issue Tracker integration in a project, navigate to the
2020-04-22 19:07:51 +05:30
[Integrations page](overview.md#accessing-integrations), click
2018-03-17 18:26:18 +05:30
the **Customer Issue Tracker** service, and fill in the required details on the page as described
2020-04-22 19:07:51 +05:30
in the table below. You will be able to edit the title and description later as well.
2018-03-17 18:26:18 +05:30
| Field | Description |
| ----- | ----------- |
2019-07-31 22:56:46 +05:30
| `title` | A title for the issue tracker (to differentiate between instances, for example). |
2018-03-17 18:26:18 +05:30
| `description` | A name for the issue tracker (to differentiate between instances, for example) |
2019-07-31 22:56:46 +05:30
| `project_url` | The URL to the project in the custom issue tracker. |
2018-03-17 18:26:18 +05:30
| `issues_url` | The URL to the issue in the issue tracker 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. For example, `https://customissuetracker.com/project-name/:id`. |
| `new_issue_url` | Currently unused. Will be changed in a future release. |
2018-03-27 19:54:05 +05:30
Once you have configured and enabled Custom Issue Tracker Service you'll see a link on the GitLab project pages that takes you to that custom issue tracker.
2018-03-17 18:26:18 +05:30
## Referencing issues
2020-04-22 19:07:51 +05:30
- Issues are referenced with `ANYTHING-<ID>`, where `ANYTHING` can be any string in CAPS and `<ID>`
is a number used in the target project of the custom integration (for example, `PROJECT-143`).
2018-10-15 14:42:47 +05:30
- `ANYTHING` is a placeholder to differentiate against GitLab issues, which are referenced with `#<ID>`. You can use a project name or project key to replace it for example.
2020-04-22 19:07:51 +05:30
- When building the hyperlink, the `ANYTHING` part is ignored, and links always point to the address
specified in `issues_url`, so in the example above, `PROJECT-143` would refer to
`https://customissuetracker.com/project-name/143`.