Integrating with source control applications
Helix ALM integrates with several source control applications, including Surround SCM, Helix Core, Git, and GitHub. Depending on the application, two-way or one-way integration may be supported.
Two-way integration
Helix ALM supports two-way integration with Surround SCM, Helix Core, Subversion, and CVS for a complete change management solution that tracks what changed and why in source files and other digital assets related to Helix ALM items.
Users can attach source files and changelists to Helix ALM items and perform actions on them, such as checking out files for editing, viewing file history, and checking in or submitting changes. Changes made in one application are also available in the other, making it easy to track historical information and trace the lifecycle of development artifacts.
One-way integration
Helix ALM supports one-way integration with Git, GitHub, Microsoft Team Foundation Server, and other source control applications that are not officially supported for Helix ALM. Users can attach source files to Helix ALM items from source control applications only. Other source control actions are not available from Helix ALM.
Integrating with these applications requires installing the Helix ALM external source control provider CGI on the web server that hosts Helix ALM and additional components on the source control server to send file information to Helix ALM. Custom scripts, webhooks, or plug-ins used to send information from the source control application to the CGI must contain a unique provider key that Helix ALM generates when you configure the integration.
Setting up integrations
Use the following information to learn more about how to integrate your source control application with Helix ALM.
| If you use: | You can: | To set up integration: | More information |
|---|---|---|---|
| Surround SCM | Attach source files and changelists to Helix ALM items and perform actions on them. | Administrator—Configure a provider for Surround SCM and set integration options. | Adding Surround SCM source control providers
Setting source control integration options |
| User—Enable the integration. | Configuring source control integration | ||
| Helix Core | Attach source files and changelists to Helix ALM items and perform actions on them. | Administrator—Configure a provider for Helix Core and set integration options. | Adding Helix Core source control providers
Setting source control integration options |
| User—Enable the integration. | Configuring source control integration | ||
| Attach changelists to Helix ALM items from Helix Core clients. | Administrator—Configure a provider for Helix Core and configure triggers. | Configuring triggers to attach changelists from Helix Core clients to Helix ALM items | |
| Subversion | Attach source files and changelists to Helix ALM items and perform actions on them. | Administrator—Configure a provider for Subversion and set integration options. | Adding Subversion source control providers
Setting source control integration options |
| CVS | Attach source files and changelists to Helix ALM items and perform actions on them. | Enable the integration. | Configuring source control integration |
| Git Other source control applications not officially supported by Helix ALM |
Attach commits to Helix ALM issues, requirements, and test cases | Administrator—Configure a provider for Git or the application and create commit and post-receive scripts for the local and server repositories. | Adding Git and other source control providers
Creating hook scripts for Git integration |
| GitHub | Attach commits to Helix ALM issues, requirements, and test cases. | Administrator—Configure a provider for GitHub and add webhooks. | Adding GitHub source control providers
Adding Helix ALM webhooks to GitHub |
| Team Foundation Server | Attach check ins to Helix ALM issues, requirements, and test cases from TFS. | Administrator—Configure a provider for TFS and install and configure the plug-in. | Adding Microsoft Team Foundation Server source control providers
Configuring the Microsoft Team Foundation Server integration plug-in |
Working with source files
After the integration is configured, you can attach source files to Helix ALM items and work with them.
Surround SCM, Helix Core, Subversion, and CVS
Attach files or changelists to Helix ALM. You can then perform other actions on them. See Working with source files.
Git, GitHub, Team Foundation Server, and other applications
To attach files to Helix ALM items, enter item tags in commit messages or check in comments. See Attaching Git, GitHub, and Team Foundation Server files to items.