This page is maintained for older versions of Spira only. The latest documentation can be found at:

SpiraTest Administration Guide Help Viewer

1. Introduction
2. Installing SpiraTeam®
3. System Administration
4. Appendices
1. Introduction
2. Installing SpiraTeam®
3. System Administration
4. Appendices

3.11.2. Version Control Integration (On-Premise Customers Only)

This section refers to the functionality available to on-premise customers of SpiraTeam. If you are using the cloud / hosted version of SpiraTeam, please refer to section 3.11.4 (TaraVault Configuration) instead.

SpiraTeam® is capable of integrating with a variety of Version Control (VC) / Software Configuration Management (SCM) tools such as Git, Subversion, CVS and TFS. This allows you to browse the source code repositories using the SpiraTeam web interface, and more importantly link revisions in these tools to artifacts in SpiraTeam. This provides the end-to-end traceability from code commits/check-ins to the tasks, incidents and requirements that necessitated the code change.

The information on using the various version control providers for SpiraTeam® and the steps for configuring the provider-specific settings are described in the SpiraPlan/Team Version Control Integration Guide.

To configure a version control provider, you need to click on the Administration > Integration > Version Control link in the Administration navigation to bring up the list of configured version control providers:

By default the only provider listed will be the TestVersionControlProvider which is used for demonstration purposes only, and can be deleted from a production system by clicking on the “Delete” button to the right of it.

  • Name: The name of the version control provider that you’re adding. This needs to match the name of the Plug-in DLL file that you’re using (see the SpiraPlan/Team Version Control Integration Guide for more details on your specific tool)
  • Description: The description is for your use only, and does not affect operation of the plug-in.
  • Active: If checked, the plug-in is active and able to be used for any project.
  • Connection Info: This field holds the root of the repository for any project accessing the plug-in, unless overridden in the Project Settings. Use the syntax that is described for your tool in the SpiraPlan/Team Version Control Integration Guide)
  • Login / Password: The user id and the password of the user to use while accessing and retrieving information from the version control system.
  • Other Fields: The other fields (Domain, Custom1 – Custom5) are provider-specific and will be described in the appropriate section of the SpiraPlan/Team Version Control Integration Guide.

When finished, click the “Insert” button and you will be taken back to the Version Control integration list page, with new provider listed as an available plug-in:

To edit the settings for an existing version control provider, click on the “Edit” button next to the name of the provider and you will be able to edit the same settings that were shown above when you first created it.

Now, you may want to change some of the settings on a per-project basis. For example you may have different repositories that you want to link to each project. You still enter the base settings for the provider as illustrated above, but then you can override specific settings for each project.

To do this, click on the “Project Settings” button next to the provider in question:

The first thing you need to do (regardless of whether you’ll be overriding any of the settings) is to make the provider active for the current project. To do this, change the toggle to “Yes” and click [Save]:

Now you can decide whether you want to override any of the default settings for this project. Any field left blank will automatically get its settings from the default values entered earlier. In the example above, we have specified a project-specific repository path, login and password. Once you have correctly configured the project, click [Save] to commit the changes.

To improve performance, SpiraTeam will cache some of the data it receives from the version control provider. Normally SpiraTeam will know when to update the cached data based on changes made in the version control system automatically. However sometimes you may wish to flush the cached data completed, to do this, click on the [Clear Cache] button.

You are now ready to use SpiraTeam® in conjunction with the version control tool you selected. For details on how to use the Source Code integration features of SpiraTeam, please refer to the SpiraTeam® User Manual.