Helix QAC operates on the code that is currently being worked on locally by the developer. In most cases, this will have originally come from a Version Control System, but it is the local version of the code that the analysis results are generated for. Analysis only needs to know the location of the local code, it does not need to know where it came from. For most people working on the desktop, there is no need to tell Helix QAC about the Version Control System.
By contrast, Dashboard normally works directly against a Version Control System. Dashboard deals not just with the current code, but it holds a series of snapshots from the lifetime of the project. Extracting historical code from a Version Control System is the most efficient way of handling this. It also ensures its reporting is accurate and traceable. Results uploaded to Dashboard normally come from a server-side automated process that extracts code from the Version Control System before generating the results. There is then a clear correspondence between results and versioned code.
A Dashboard Unified project (see Working with Helix QAC Dashboard) will have a configuration file attached to it that gives details on the Version Control System. This is known as a Version Control Compatibility File (VCF) file. There is no need to create this file locally, this is done centrally within Dashboard, and the necessary file is simply pulled down from the server as part of the project definition.
The only circumstances where a VCF file needs to be created or adjusted locally are:
- If the Baseline by Version Control feature is being used then baselining needs a reference copy of the code, so that it can compare the current code with the code that existed when the baseline was taken.
- The current project is not a Unified project, but results generated against checked-in code need to be uploaded to Dashboard.
- For some Version Control Systems, a VCF file that is pulled down from Dashboard may need adjustment for local usage.
To provide the necessary information, select ’Open Project Properties’ and then select the ’Version Control Configuration’ panel.
A number of scripts exist for popular version control systems. They can be imported using the ’Import’ button. When imported, the script is displayed in the ’VCF Script’ panel. The script can be edited if necessary to work with your particular Version Control System.
You should first verify that the script works (see VCF File Testing). Once this has been confirmed, be sure to save the Project Properties. The script will then be used by Helix QAC.
project.vcf.