Skip to content

2.10 Creating Work Items

Martin Benninger edited this page Apr 8, 2019 · 18 revisions

The plugin is capable of creating work items from Git issues. This can be used to create single or multiple work items from issues that have been created in GitHub/GitLab. To use this functionality the plugin needs to be opened in the new work item mode.

Getting into the new work item mode

The simplest way to get into the new work item mode is to open the work items menu in RTC and click on one of the entries in the "Create Work Item from Git Issue" section.

Work Items Menu

By default, this menu contains the work item types "Defect" and "Story" but it may have been customized by the system administrators to contain other work item types. Depending on the setup and configuration done by the admins you may not see this section in the menu at all. In that case, you can still create work items from Git issues using the method described in the next section.

If you don't see the menu section mentioned above or if you'd like to create the Git issues using a different work item type, you can simply create a new work item of that type using the normal menu. From the new work item editor, you should see the Git connector plugin button is enabled.

New Work Item Button Enabled

Be sure to click the Git connector plugin button before making changes to the work item because the button will be disabled as soon as any changes have been made. When disabled the button will be greyed out and will not open the plugin. This is to prevent data loss as any changes made to the work item would be overridden by the plugin.

Selecting Git issues

Once the plugin has opened in the new work item mode you can select a Git repository as is described in the Selecting a Git Repository page.

The plugin will then show a list of recent issues created on the connected Git platform. The issues can be selected just like in the normal mode. The searching and filtering features also work as normal.

Select Git Issues

It's possible that you will see a warning symbol to the right of the item like in the image below.

Create Work Item Warning

This warning symbol indicates that the Git issue has already been created as a work item. This information can also be seen by hovering over the icon. You can still create a work item from this Git issue (maybe you need to create it in a different project area). This is just meant to help prevent the accidental creation of duplicate work items.

Setting some work item attributes

After selecting at least one Git issue from the list a new section will appear enabling you to set the values of some work item attributes. If you have selected multiple Git issues the work item attributes will be set on all the new work items created.

Set Work Item Attributes

This enables you to set some values that should be the same for all the new work items including some commonly required attributes. It's also possible to set a parent work item for all the new work items. This will cause the new work items to be children of that item.

Saving the new work items

After selecting the desired Git issues and optionally setting some work item attribute values you can click the save button to create the new work items. The plugin will create a work item for each selected Git issue. All work items will be created with the same type as the first work item.

All the new work items will have the title, description, and tags taken from the Git issues as well as an extra tag "from-git-issue". The plugin will attempt to save all the new work items with the new values and if all required attributes are set the work items should be successfully saved.

If some required attributes were not set or if there was some other error, the work items will only be created but not saved. All the new work items that need attention before they can be saved will appear in a list above the work item editor. You can then click on the new work items to manually correct the errors and save the work item.

Unsaved New Work Items

Once all new work items have successfully been saved a link to a query will show up at the top of the page. This will open a query that shows all the work items created from Git issues by the current user in the last day.

Finished Creating Work Items

This is a great way to see all the new work items that have been created and even do some multiple editing if necessary.

New Work Items Query

When viewing any of the new work items you will see that it contains a link to the Git issue that it was created from. The Git issue will also contain a comment with a link to the new work item. Take a look at the rest of the wiki pages here for more information about the links created by the RTC Git Connector plugin.