Table of Contents

Tools: GitHub

This topic explains how to integrate TestRail with GitHub. There are currently three ways to integrate TestRail with GitHub, namely:

You don't have to use all listed integration options and you can mix and match the integration with other tools. Configuring the integration usually only takes a few minutes and this guide explains how to configure the integration and how it works.

Defect URLs

The defect URLs are used to let TestRail know how to access your GitHub instance. Once the URLs have been configured, a new Add link appears next to the Defects field in the Add Test Result dialog. This link allows you to jump to GitHub's New Issue form to report a new bug. Additionally, entered issue IDs are linked to your GitHub instance to make it easier to track the status of your issues.

To configure GitHub's URLs in TestRail, select Administration > Integration. You can alternatively enter separate bug tracker URLs for each project under Administration > Projects. Use the following example URLs to configure the addresses:

GitHub installation
Defect View Url: https://github.com/<owner>/<repository>/issues/%id%
Defect Add Url:  https://github.com/<owner>/<repository>/issues/new

Please make sure to replace <owner> and <repository> with the actual keys of the owner and repository in GitHub you want to integrate with.

Defect plugins

Defect plugins can be used to implement a deeper bug tracker integration and TestRail comes with a ready-to-use GitHub defect plugin. To configure the defect plugin, select Administration > Integration and select GitHub in the Defect Plugin dropdown list. The next step is to configure all the necessary connection settings in the Configuration field. Project specific plugins and configuration settings can optionally be specified under Administration > Projects.

When the defect plugin has been configured, a new Push link is shown next to the Defects field in the Add Test Result dialog. Clicking the link will open a popup dialog that enables you to push a bug report to GitHub without leaving TestRail. Once the test result was added, hovering the mouse cursor over an issue ID will open a window with useful information and status details about the issue in GitHub.

Please note: The GitHub defect plugin was introduced with TestRail 3.0 but is also available for older TestRail versions on request.

Customizations

The GitHub defect plugin was built to work with a standard GitHub configuration. TestRail allows you to customize the integration and please see the following articles for details on how to do this:

Reference URLs

The reference URLs are used to link test cases to issues stored in GitHub via the References field. Once the URLs have been configured, issue IDs entered in the References field are linked to your GitHub instance to make it easier to jump to related issues, feature specifications or requirements.

To configure GitHub's URLs for the References field, select Administration > Integration. You can alternatively enter separate reference URLs for each project under Administration > Projects. Use the following example URLs to integrate TestRail with GitHub:

GitHub installation
Reference View Url: https://github.com/<owner>/<repository>/issues/%id%
Reference Add Url:  https://github.com/<owner>/<repository>/issues/new

Please make sure to replace <owner> and <repository> with the actual keys of the owner and repository in GitHub you want to integrate with.