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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

56 lines
2.4 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2021-10-27 15:23:28 +05:30
stage: Ecosystem
group: Integrations
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
2021-01-29 00:20:46 +05:30
---
2021-03-11 19:13:27 +05:30
# IBM Engineering Workflow Management (EWM) Integration **(FREE)**
2020-11-24 15:15:51 +05:30
2021-06-08 01:23:25 +05:30
This service allows you to go from GitLab to EWM work items mentioned in merge request
descriptions and commit messages.
Each work item reference is automatically converted to a link to the work item.
2020-11-24 15:15:51 +05:30
2021-06-08 01:23:25 +05:30
This IBM product was [formerly named Rational Team Concert](https://jazz.net/blog/index.php/2019/04/23/renaming-the-ibm-continuous-engineering-portfolio/)(RTC). This integration is compatible with all versions of RTC and EWM.
2020-11-24 15:15:51 +05:30
2021-06-08 01:23:25 +05:30
To enable the EWM integration, in a project:
2020-11-24 15:15:51 +05:30
2022-06-21 17:19:12 +05:30
1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
2021-06-08 01:23:25 +05:30
1. Select **EWM**.
1. Select the checkbox under **Enable integration**.
1. Fill in the required fields:
- **Project URL**: The URL to the EWM project area.
To obtain your project area URL, navigate to the
path `/ccm/web/projects` and copy the listed project's URL. For example, `https://example.com/ccm/web/Example%20Project`.
- **Issue URL**: The URL to the work item editor in the EWM project area.
The format is `<your-server-url>/resource/itemName/com.ibm.team.workitem.WorkItem/:id`.
GitLab replaces `:id` with the issue number
(for example, `https://example.com/ccm/resource/itemName/com.ibm.team.workitem.WorkItem/:id`,
which becomes `https://example.com/ccm/resource/itemName/com.ibm.team.workitem.WorkItem/123`).
- **New issue URL**: URL to create a new work item in the EWM project area.
Append the following fragment to your project area URL: `#action=com.ibm.team.workitem.newWorkItem`.
For example, `https://example.com/ccm/web/projects/JKE%20Banking#action=com.ibm.team.workitem.newWorkItem`.
1. Select **Save changes** or optionally select **Test settings**.
2020-11-24 15:15:51 +05:30
## Reference EWM work items in commit messages
2021-06-08 01:23:25 +05:30
To refer to work items, you can use any keywords supported by the EWM Git Integration Toolkit.
Use the format: `<keyword> <id>`.
2020-11-24 15:15:51 +05:30
You can use the following keywords:
- `bug`
- `defect`
- `rtcwi`
2021-06-08 01:23:25 +05:30
- `task`
2020-11-24 15:15:51 +05:30
- `work item`
2021-06-08 01:23:25 +05:30
- `workitem`
2020-11-24 15:15:51 +05:30
2021-06-08 01:23:25 +05:30
Avoid using the keyword `#`. Learn more in the EWM documentation page
[Creating links from commit comments](https://www.ibm.com/docs/en/elm/7.0.0?topic=commits-creating-links-from-commit-comments).