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

39 lines
1.9 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Create
group: Ecosystem
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-04-17 20:07:23 +05:30
# Custom Issue Tracker service **(FREE)**
2018-03-17 18:26:18 +05:30
2020-06-23 00:09:42 +05:30
To enable the Custom Issue Tracker integration in a project:
2018-03-17 18:26:18 +05:30
2020-10-24 23:57:45 +05:30
1. Go to **Settings > Integrations**.
2020-06-23 00:09:42 +05:30
1. Click **Custom Issue Tracker**
1. Fill in the tracker's details, such as title, description, and URLs.
2021-02-22 17:27:13 +05:30
You can edit these fields later as well.
2018-03-17 18:26:18 +05:30
2020-06-23 00:09:42 +05:30
These are some of the required fields:
| Field | Description |
| --------------- | ----------- |
| **Project URL** | The URL to the project in the custom issue tracker. |
| **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`. |
2021-02-22 17:27:13 +05:30
| **New issue URL** | Currently unused. Planned to be changed in a future release. |
2020-06-23 00:09:42 +05:30
1. Click **Test settings and save changes**.
2021-02-22 17:27:13 +05:30
After you configure and enable the Custom Issue Tracker service, you see a link on the GitLab
2020-06-23 00:09:42 +05:30
project pages that takes you to that custom issue tracker.
2018-03-27 19:54:05 +05:30
2018-03-17 18:26:18 +05:30
## Referencing issues
2020-06-23 00:09:42 +05:30
Issues are referenced with `<ANYTHING>-<ID>` (for example, `PROJECT-143`), where `<ANYTHING>` can be any string in CAPS, and `<ID>`
is a number used in the target project of the custom integration.
`<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.
When building the hyperlink, the `<ANYTHING>` part is ignored, and links always point to the address
2020-04-22 19:07:51 +05:30
specified in `issues_url`, so in the example above, `PROJECT-143` would refer to
`https://customissuetracker.com/project-name/143`.