Working with source files
You can attach files managed in source control to items in Helix ALM, which allows you to work with files without switching between applications. For example, you may want to attach source files that need updates to fix an issue. After the files are attached to the issue, you can check them out, make changes, check in the files, and fix the issue to track all the related changes in both applications.
Note: When working with Git, GitHub, and Microsoft Team Foundation Server, you can only attach files from the source control application. You can view the attached files on the Source Files tab in Helix ALM items, but additional source control actions are not available. See Viewing Git, GitHub, and Team Foundation Server files attached to items.
Accessing source files and actions
Source files can be attached to items by users when working in Helix ALM or, in some cases, the source control application. To view source files and actions, open the Source Files tab when you are viewing or editing an item.
- Issues—Click the Source Files tab.
- Requirements and documents—Click the Files tab and then click Source Files.
- Test cases and test runs—Click the Files tab and then click the Source Files tab.
Tip: Source files and changelists may be displayed as hyperlinks depending on the source control provider configuration in the project. Click the link to open the file or changelist in the source control application. The Helix ALM administrator configures providers. See Adding Surround SCM source control providers.
Performing actions on source files
Click a button on the Source Files tab to perform a source control file action related to the item.
The actions you have access to may vary depending on the source control application you are using. The following actions are available if you use Surround SCM or Helix Versioning Engine. If you use a different application, refer to its documentation for more information.
| Button | Use to: | More information |
|---|---|---|
| Attach Changelist | Attach a source control changelist to the item. Changelists group related file actions and allow for atomic transactions where all actions are performed at the same time. You must attach a changelist to an item before you can perform actions on it in Helix ALM. Available for issues, requirements, and test cases only. | Attaching source control changelists to items |
| Attach File | Attach a source file to the item. You must attach a file to an item before you can perform actions on it in Helix ALM. | Attaching source files to items |
| Detach | Remove the selected file or changelist from the item. | Detaching source files and changelists from items |
| Get | Retrieve a local copy of the selected file from the source control application. | Getting source files |
| Commit Changelist (Surround SCM only) | Commit the selected pending changelist to the source control application. Available for issues, requirements, and test cases only. | Committing pending changelists |
| Check In (Surround SCM) Submit (Helix Versioning Engine) |
Check in changes made to the selected file to the source control application. | Checking in or submitting source files |
| Check Out | Check out the selected file from the source control application to make changes to it. | Checking out source files |
| Undo Check Out (Surround SCM) Revert (Helix Versioning Engine) |
Remove the lock on the selected checked out file in the source control application. | Undoing or reverting source file check out |
| View Local Copy | View the local copy of the selected file. | Viewing local copies of source files |
| View | View changelists and files included in them. | Viewing source control changelists |
| History | View the file history. You may also be able to perform other actions, such as comparing file differences, when viewing history. | Viewing source file history |
Including source file information in reports, email templates, and other areas
You can use field codes to include information about source files attached to items in reports, email templates, and other Helix ALM areas that support field codes. Use %SRCFILE% to include a detailed list of source file information that includes the item, source file name, changelist, versions, provider, and timestamp. Use %SRCFILECON% to include a more condensed list with the same information. See Field codes for information.
