Adding GitHub source control providers

Add a GitHub source control provider to allow users to attach commits to Helix ALM issues, test cases, and requirements from GitHub.

This also provides hyperlinks to view source files and commits on the Helix ALM item Source Files tab and in other areas, such as reports.

1. Make sure the Helix ALM external source control provider CGI (ttextpro.exe) is installed on the web server that hosts Helix ALM. See the installation help for information.

2. Make sure external source control provider access is enabled in the Helix ALM Registry Utility. This is required to send attachment information from source control applications to Helix ALM. See the Registry Utility help for information.

3. Choose Tools > Administration > Source Control Providers.

The Source Control Providers dialog box opens.

4. Click Add.

5. Enter the provider Name. You can enter up to 256 characters. Provider names must be unique.

6. Select GitHub as the Type.

7. Enter the full Repository URL for the GitHub repository.

8. Enter the full Provider CGI URL to the ttextprop.exe CGI on the web server. For example, http://web.server.address/cgi-bin/ttextpro.exe (Apache) or http://web.server.address/scripts/ttextpro.exe (IIS).

The provider key and webhook payload URL are automatically generated for the integration. These values are used when configuring webhooks in GitHub to pass attachment information from GitHub to Helix ALM.

9. Make sure Active is selected so users can use the integration. This option is selected by default.

10. Click OK to save the provider.

After the provider is added, you must add a webhook for the repository in GitHub using the webhook payload URL from this dialog box. See Adding Helix ALM webhooks to GitHub.