Capturing issue or commit discussion comments

You can capture issue comments or commit discussion comments in IBM® Engineering Workflow Management work items when those comments have references to work items. For example, if a commit discussion or issue comment has the words defect 320, defect 380, then these comments are captured in those two defects.

Before you begin

To capture commit messages in work items, you must first perform the configuration steps described in Configuring the basic integration with GitHub Enterprise.

A shared user base, such as a common LDAP, between Engineering Workflow Management and the GitHub Enterprise server is optional. It is recommended to add an Engineering Workflow Management functional user ID to the webhook configuration when you register the GitHub repository (Registering the GitHub repository in Engineering Workflow Management). Ensure that the functional user is authorized for Git requests.

About this task

In Configuring the basic integration with GitHub Enterprise, you configured a webhook. To capture GitHub issue or commit discussion comments in Engineering Workflow Management work items, update the configuration of that webhook. For a list of supported keywords in the issue or commit discussion comment, see Creating links from commit message.

1. Configure a webhook in the GitHub Enterprise repository.
   1. In a web browser, open the GitHub repository.
   2. Click the Settings tab.
   3. In the navigation pane, click Hooks.
   4. In the Webhooks section, find the webhook that you created previously. Click Edit.
   5. Under Which events would you like to trigger this webhook?, select Let me select individual events. In the options displayed, select Issues, Commit Comment, and Issue Comment.
   6. Click Update webhook to complete the configuration of the webhook in GitHub Enterprise.
2. Optional: To disable replication of content from the issue or commit discussion in work items:
   1. In the web client, log in to Engineering Workflow Management. For example, go to https://host_name:9443/ccm/web.
   2. On the Engineering Workflow Management project page, click Source Control > Work with Git.
   3. Click Browse Registered Git Repositories.
   4. Select the repository that you registered.
   5. Expand the GitHub/GitLab Configuration section.
   6. Clear Replicate comments from commit or issue discussion.
   7. Click Save.
3. Specify work items in commit discussions.
   • To capture commit discussion in a work item, mention the work item number after a supported keyword in the commit discussion comment. For example: fix rtcwi 123. For the full list of keywords, see Associating work items with commits.
   • To capture issue discussion in a work item, mention the work item number after a supported keyword in the issue discussion comment.